• DeutschEnglish

Klarna Sofort via PPRO

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).

Logo

COO 6505 1000 5 6092878

Info

The international online bank transfer with PIN/TAN from Sofort GmbH is now available in 7 countries. As part of the Klarna Group Sofort offers the integration of payment in the webshop, so that a customer is forwarded to his/her bank and can make the transfer with input of PIN and TAN.

Type

Payments by Online Bank Transfer

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

Process flow for Sofort via PPRO

Paygate interface

Definitions
Data formats

Format

Description

a

alphabetical

as

alphabetical with special characters

n

numeric

an

alphanumeric

ans

alphanumeric with special characters

ns

numeric with special characters

bool

boolean expression (true or false)

3

fixed length with 3 digits/characters

..3

variable length with maximum 3 digits/characters

enum

enumeration of allowed values

dttm

ISODateTime (YYYY-MM-DDThh:mm:ss)

Abbreviations

Abbreviation

Description

Comment

CND

condition

M

mandatory

If a parameter is mandatory, then it must be present

O

optional

If a parameter is optional, then it can be present, but it is not required

C

conditional

If a parameter is conditional, then there is a conditional rule which specifies whether it is mandatory or optional

Notice: Please note that the names of parameters can be returned in upper or lower case.

Calling the interface

To carry out an online transfer with Sofort via PPRO, please use the following URL:

https://www.computop-paygate.com/sofort.aspx

Notice: For security reasons, Computop 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:

KeyRESTFormatCNDDescription

MerchantID

BasicAuth.Username

ans..30

M

MerchantID, assigned by Computop. Additionally this parameter has to be passed in plain language too.

TransID

"transactionId": "..."

ans..64

M

TransactionID provided by you which should be unique for each payment

refnr

"referenceNumber": "..."

ans..40

O

Merchant’s unique reference number. Only characters a-zA-Z0-9,-_ are allowed.

Amount

"amount": { "value": ...}

n..10

M

Amount in the smallest currency unit (e.g. EUR Cent). Please contact the Computop Helpdesk, if you want to capture amounts <100 (smallest currency unit).

Currency

"amount": { "currency": "..."}

a3

M

Currency, three digits DIN / ISO 4217. Only EUR permissible. Please find an overview here: A1 Currency table

MAC

–––

an64

M

Hash Message Authentication Code (HMAC) with SHA-256 algorithm. Details can be found here:

OrderDesc

"order": {"description[0]": "..."}

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

"payment": {"sofort": {"account": {"accountHolder": "..."}}}

ans3..50

M

Name of account holder

IBAN

"payment": {"sofort": {"account": {"number": "..."}}}

an..34

O

IBAN of the user which appears predefined in the transfer window (only possible for DE)

BIC

"payment": {"sofort": {"account": {"code": "..."}}}

an..11

O

BIC of the user which appears predefined in the transfer window

AddrCountryCode

"billing": {"addressInfo": {"country": {"A2": "..."}}}

a2

M

Two characters country code according to ISO 3166. Presently DE, AT, BE, NL, ES, CH, IT permitted.

Language

"language": "..."

a2

O

Language: de – German, en – English, fr – French, nl – Dutch, pl – Polish

URLSuccess

"urls": {"success": "..."}

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.

Common notes:

  • We recommend to use parameter "response=encrypt" to get an encrypted response by Paygate

  • However, fraudster may just copy the encrypted DATA-element which are sent to URLFailure and send the DATA to URLSuccess/URLNotify. Therefore ensure to check the "code"-value which indicates success/failure of the action. Only a result of "code=00000000" should be considered successful.

URLFailure

"urls": {"failure": "..."}

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.

Common notes:

  • We recommend to use parameter "response=encrypt" to get an encrypted response by Paygate

  • However, fraudster may just copy the encrypted DATA-element which are sent to URLFailure and send the DATA to URLSuccess/URLNotify. Therefore ensure to check the "code"-value which indicates success/failure of the action. Only a result of "code=00000000" should be considered successful.

Response

–––

a7

O

Status response sent by Paygate to URLSuccess and URLFailure, should be encrypted. For this purpose, transmit Response=encrypt parameter.

URLNotify

"urls": {"notify": "..."}

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 UserDataparameter instead.

Common notes:

  • Before follow-up actions (capture / credit / reversal) are carried out on an existing transaction, the first Notify must have been answered by the shop.

  • Fraudster may just copy the encrypted DATA-element which are sent to URLFailure and send the DATA to URLSuccess/URLNotify. Therefore ensure to check the "code"-value which indicates success/failure of the action. Only a result of "code=00000000" should be considered successful.

UserData

"metadata[userData]": "..."

ans..1024

O

If specified at request, Paygate forwards the parameter with the payment result to the shop.

ReqId

"requestId": "..."

ans..32

O

To avoid double payments or actions (e.g. by ETM), enter an alphanumeric value which identifies your transaction and may be assigned only once. If the transaction or action is submitted again with the same ReqID, Computop Paygate will not carry out the payment or new action, but will just return the status of the original transaction or action.

Please note that the Computop Paygate must have a finalized transaction status for the first initial action (authentication/authorisation). This does not apply to 3-D Secure authentications that are terminated by a timeout. The 3-D Secure Timeout status does not count as a completed status in which the ReqID functionality on Paygate does not take effect. Submissions with identical ReqID for an open status will be processed regularly.

Notice: Please note that a ReqID is only valid for 12 month, then it gets deleted at the Paygate.

SellingPoint

ans..50

O

Selling point

Service

ans..50

O

products or service sold

Channel

"channel": {"code": "..."}

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

"metadata[plain]": "..."

ans..50

O

A single value to be set by the merchant to return some information unencrypted in response/notify, e.g. the MID.

"Plain"-parameter is part of encrypted "Data" in Computop Paygate and therefore protected against manipulation.

Custom

"metadata": "..."

ans..1024Format

O

"Custom"-parameter is added to the request data before encryption and is part of encrypted "Data" in Computop Paygate request. By this they are protected against manipulation by a consumer.

The Custom-value is added to the Computop Paygate response in plain text and the "|" is replaced by a "&". By this you can put a single value into Custom-parameter and get multiple key-value-pairs back in response for your own purpose.

Please find a sample here: Custom

Parameters for Sofort via PPRO

In case of using REST API

In case of using REST API you will always receive a link where the merchant has to redirect the consumer to complete the payment.

REST

Format

CND

Description

"paymentId": "..."

an32

M

May be "00000000000000000000000000000000" if not yet set by Computop Paygate

"_Links.self.type": "..."

an..20

M

"application/json"

"_Links.redirect.href": "..."

an..1024

M

Merchant needs to redirect consumer to this URL to complete payment

"_Links.redirect.type": "..."

an..20

M

"text/html"

Merchant can use inquire.aspx

In case of using Key-Value-Pair API

The following table gives the result parameters which Computop Paygate transmits to URLSuccess or URLFailure and URLNotify. If you have specified the Response=encrypt parameter, the following parameters are sent Blowfish encrypted to your system:

pls. be prepared to receive additional parameters at any time and do not check the order of parameters

the key (e.g. MerchantId, RefNr) should not be checked case-sentive

KeyFormatCNDDescription

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 as well as for capture or credit request.

XID

an32

M

ID for all single transactions (authorisation, capture, credit note) for one payment assigned by Paygate

TransID

ans..64

M

TransactionID provided by you which should be unique for each payment

Status

a..50

M

OK or AUTHORIZED (URLSuccess) as well as FAILED (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

an8

M

Error code according to Paygate Response Codes (A4 Error codes)

refnr

ans..40

O

Merchant’s unique reference number. Only characters a-zA-Z0-9,-_ are allowed.

UserData

ans..1024

O

If specified at request, Paygate forwards the parameter with the payment result to the shop.

MAC

an64

M

Hash Message Authentication Code (HMAC) with SHA-256 algorithm. Details can be found here:

PaymentPurpose

ans..26

O

Purpose of payment

PaymentGuarantee

a..12

C

Value

Description

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

C

Detailed PPRO error message.

Notice: Is returned only if Status=FAILED. Use is possible only in agreement with Computop Helpdesk.

TransactionID

an..20

O

Unique transaction number from PPRO

AccOwner

ans3..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 single value to be set by the merchant to return some information unencrypted in response/notify, e.g. the MID.

"Plain"-parameter is part of encrypted "Data" in Computop Paygate and therefore protected against manipulation.

Custom

ans..1024

O

"Custom"-parameter is added to the request data before encryption and is part of encrypted "Data" in Computop Paygate request. By this they are protected against manipulation by a consumer.

The Custom-value is added to the Computop Paygate response in plain text and the "|" is replaced by a "&". By this you can put a single value into Custom-parameter and get multiple key-value-pairs back in response for your own purpose.

Please find a sample here: Custom

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:

https://www.computop-paygate.com/credit.aspx

Notice: For security reasons, Computop 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:

KeyRESTFormatCNDDescription

MerchantID

BasicAuth.Username

ans..30

M

MerchantID, assigned by Computop. Additionally this parameter has to be passed in plain language too.

PayID

"paymentId": "..."

an32

M

ID assigned by Paygate for the payment to be credited

TransID

"transactionId": "..."

ans..64

M

TransactionID provided by you which should be unique for each payment

Amount

"amount": { "value": ...}

n..10

M

Amount in the smallest currency unit (e.g. EUR Cent). Please contact the Computop Helpdesk, if you want to capture amounts <100 (smallest currency unit).

Currency

"amount": { "currency": "..."}

a3

M

Currency, three digits DIN / ISO 4217, e.g. EUR, USD, GBP. Please find an overview here: A1 Currency table

MAC

–––

an64

M

Hash Message Authentication Code (HMAC) with SHA-256 algorithm. Details can be found here:

ReqId

"requestId": "..."

ans..32

O

To avoid double payments or actions (e.g. by ETM), enter an alphanumeric value which identifies your transaction and may be assigned only once. If the transaction or action is submitted again with the same ReqID, Computop Paygate will not carry out the payment or new action, but will just return the status of the original transaction or action.

Please note that the Computop Paygate must have a finalized transaction status for the first initial action (authentication/authorisation). This does not apply to 3-D Secure authentications that are terminated by a timeout. The 3-D Secure Timeout status does not count as a completed status in which the ReqID functionality on Paygate does not take effect. Submissions with identical ReqID for an open status will be processed regularly.

Notice: Please note that a ReqID is only valid for 12 month, then it gets deleted at the Paygate.

Parameters for credits via socket connections

The following table describes the result parameters with which the Computop Paygate responds to your system

pls. be prepared to receive additional parameters at any time and do not check the order of parameters

the key (e.g. MerchantId, RefNr) should not be checked case-sentive

KeyRESTFormatCNDDescription

mid

"merchantId": "..."

ans..30

M

MerchantID, assigned by Computop

PayID

"paymentId": "..."

an32

M

ID assigned by Paygate for the payment, e.g. for referencing in batch files as well as for capture or credit request.

XID

"xId": "..."

an32

M

ID for all single transactions (authorisation, capture, credit note) for one payment assigned by Paygate

TransID

"transactionId": "..."

ans..64

M

TransactionID provided by you which should be unique for each payment

Status

"status": "OK"

"status": "FAILED"

a..50

M

OK (URLSuccess) or FAILED (URLFailure)

Description

"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

"code": ...

an8

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:

Actiob

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 Sofort within a Batch file to be submitted is the following:

1
HEAD,<MerchantID>,<Date>,<Version>
2
SOFORT,Credit,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID>
3
FOOT,<CountRecords>,<SumAmount>

Example for Master MID function:

1
HEAD,[Master]MerchantID,Date,2.x
2
Type,Action,[Slave]MID,Amount,Currency,TransID,Data (depends on Action)
3
FOOT,CountRecords,SumAmount

The following table describes the individual fields and values used within the data set (record) in the batch file:

KeyFormatCNDDescription

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). Please contact the Computop Helpdesk, if you want to capture amounts <100 (smallest currency unit).

Currency

a3

M

Currency, three digits DIN / ISO 4217, e.g. EUR, USD, GBP. Please find an overview here: A1 Currency table

TransID

ans..64

M

TransactionID provided by you which should be unique for each payment

refnr

ans..40

O

Merchant’s unique reference number. Only characters a-zA-Z0-9,-_ are allowed.

PayID

an32

M

ID assigned by Paygate for this transaction

Description of fields within the record for Batch files

The record area within the response file for Batch transactions looks as follows:

1
HEAD,<MerchantID>,<Date>,<Version>
2
SOFORT,Credit,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID>,<Status>,<Code>
3
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):

KeyFormatCNDDescription

Action

a..20

M

The parameter Action defines the type of transaction:

Credit

PayID

an32

M

ID assigned by Paygate for this transaction

Status

a..50

M

OK (URLSuccess) or FAILED (URLFailure)

Code

an8

M

Error code according to Paygate Response Codes (A4 Error codes)

Description of result parameters within the record for Batch files

Paygate

Documentation (EN)

Dokumentation (DE)

Paygate Status