Table of Contents |
---|
About Sofort
General information about Sofort
Sofort is a method of bank transfers and is based on online banking. A big advantage is: The customer doesn’t need to register and does not need to create a virtual account, a so called wallet. As the name suggests it is an immediate bank transfer and thus a direct bank transfer. The customer selects Sofort as payment method for their online purchase and is then forwarded to the secure payment form. The bank transfer data is transferred automatically and the customer only has to select his or her bank and enter their login details for online banking. Finally he releases the bank transfer by means of an approval code. All data is send encrypted to the online banking account. The online merchant receives a real-time confirmation of the executed bank transfer. The merchant can execute and dispatch the order immediately delivering goods/services faster. There is no waiting time until the dispatch of the goods like it would be for example in the case of prepayment via bank transfer.
As usual with online banking, the data disclosed in Sofort are encrypted with SSL (Secure Sockets Layer).
Page properties | ||||||||
---|---|---|---|---|---|---|---|---|
|
Further information can be found on the webpage of Sofort (https://www.sofort.com/ger-DE/verkaeufer/su/e-payment-sofort-ueberweisung).
Process flow chart
Multiexcerpt | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||
|
Process flow for Sofort within Paygate
Paygate interface
via PPRO
Multiexcerpt include | |||
---|---|---|---|
|
|
|
Calling the interface
interface
Multiexcerpt include | ||||||
---|---|---|---|---|---|---|
|
Calling the interface
To carry To carry out an online transfer with Sofort via PPRO, go to please use the following URL:
sofort.aspx |
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
TransactionID which should be unique for each payment
RefNr
ans..40
O
Unique reference number. Only characters a-zA-Z0-9,-_ are allowed.
Amount
n..10
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
Three digits DIN / ISO 4217. Only EUR permissible.
OrderDesc
ans..384
M
Reason for payment on customer-account statement. Notice: Only the first 27 characters appear on the customer-account statement. You can view the full data in Computop Analytics.
AccOwner
as..50
M
Name of account holder
IBAN
an..34
O
IBAN of the user which appears predefined in the transfer window (only possible for DE).
BIC
an..11
O
BIC of the user which appears predefined in the transfer window
AddrCountryCode
a2
M
Two characters country code according to ISO 3166. Presently DE, AT, BE, NL, ES, CH, PL, IT permitted.
Language
a2
O
Language: de - German, en – English, fr- French, nl - Dutch, pl - Polish
MAC
an64
M
Hash Message Authentication Code (HMAC) with SHA-256 algorithm
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. Please note that the Paygate 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
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
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 Sofort via PPRO
The following table gives the result parameters which the Paygate 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
M
MerchantID, assigned by Computop
PayID
an32
M
ID assigned by Paygate for the payment For example 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..64
M
Merchant’s transaction number
Status
a..50
M
OK or AUTHORIZED (URLSuccess) as well as FAILED or AUTHORIZE_REQUEST (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 (A4 Error codes)
RefNr
ans..40
O
Unique reference number. Only characters a-zA-Z0-9,-_ are allowed.
MAC
an64
M
Hash Message Authentication Code (HMAC) with SHA-256 algorithm
UserData
ans..1024
O
If specified upon call, Paygate forwards the parameter with the payment result to the shop
PaymentPurpose
ans..26
M
Purpose of payment
PaymentGuarantee
a..12
C
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..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
AccOwner
as..50
O
Name of account holder
AccBank
ans..50
O
Name of the account holder’s bank
IBAN
an..34
O
International Bank Account Number
BIC
an..11
O
Bank Identifier Code
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 Sofort via PPRO
Credit with Sofort
Credits (refunds) are possible via a Server-to-Server connection. For a Credit with reference to a capture 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 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
Paygate ID for the identification of a payment
TransID
ans..64
M
ID assigned by Merchant for the payment process to be credited
Amount
n..10
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
Three digits DIN / ISO 4217.
MAC
an64
M
Hash Message Authentication Code (HMAC) with SHA-256 algorithm
Parameters for credits via socket connections
The following table gives the parameters with which the Paygate responds:
Parameter
Format
CND
Description
MID
ans..30
M
MerchantID, assigned by Computop
PayID
an32
M
ID assigned by Paygate for the payment. Important for future reference.
XID
an32
M
ID assigned by Paygate for the payment transaction
TransID
ans..64
M
TransactionID which should be unique for each payment
Status
a..50
MC
OK or FAILED
Description
a..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 (A4 Error codes)
Response parameters for credits with Sofort 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 a refund for Sofort and which information can be found within the response file about the payment status.
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)
Multiexcerpt include SpaceWithExcerpt EN MultiExcerptName Request_Intro PageWithExcerpt Reuse API
Table Filter | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Parameters for Sofort via PPRO
Multiexcerpt include SpaceWithExcerpt EN MultiExcerptName Response_IntroURL PageWithExcerpt Reuse API
Table Filter | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Result parameters for URLNotify, URLSuccess and URLFailure in case of Sofort via PPRO
Credit with Sofort
Credits (refunds) are possible via a Server-to-Server connection. For a Credit with reference to a capture 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:
|
Multiexcerpt include SpaceWithExcerpt EN MultiExcerptName Request_Intro PageWithExcerpt Reuse API
Table Filter | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Parameters for credits via socket connections
Multiexcerpt include SpaceWithExcerpt EN MultiExcerptName Response_Intro PageWithExcerpt Reuse API
Table Filter | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Response parameters for credits with Sofort 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 a refund for Sofort and which information can be found within the response file about the payment status.
Following table gives an overview of all batch versions that are possible for a specific action an their specialities:
Table Filter | ||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||
|
Description of the possible batch versions
The structure for Sofort within a Batch file to be submitted is the following:
Multiexcerpt | |||||
---|---|---|---|---|---|
| |||||
|
Example for Master MID function:
Multiexcerpt | |||||
---|---|---|---|---|---|
| |||||
|
The following table describes the individual fields and values used within the data set (record) within the batch file:
Table Filter | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Description of fields within the record for Batch files
The record area within the response file for Batch transactions looks the following way:
Multiexcerpt | |||||
---|---|---|---|---|---|
| |||||
|
Description of the possible batch versions
The structure for Sofort within a Batch file to be submitted is the following:
HEAD,<MerchantID>,<Date>,<Version>
|
|
Example for Master MID Funktion:
HEAD,[Master]MerchantID,Date,2.xType,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) within the batch file:
Parameter
Format
CND
Description
Type
a..11
M
HEAD for Header, FOOT for Footer, SOFORT for Sofort
Action
a..20
M
The parameter Action defines the type of transaction:
Credit
Amount
n..10
M
Amount in the smallest currency unit (e.g. EUR Cent)
Currency
a3
M
Three digits DIN / ISO 4217
TransID
ans..64
M
TransactionID which should be unique for each payment
RefNr
ans..40
O
Unique reference number. Only characters a-zA-Z0-9,-_ are allowed.
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:
SOFORT,Credit,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID>,<Status>,<Code>
response parameters which the Batch Manager saves in the Record area for each transaction (standard parameters not explained here, such as <TransID> or <RefNR> correspond to the call as specified above):
Table Filter | |||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||
|
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> correspond to the call as specified above):
Parameter
Format
CND
|
PayID
an32
M
ID for this transaction given by Paygate
Status
a..50
M
OK or FAILED
|
Code
n8
M
Description of result parameters within the record for Batch files