About giropay

General information about giropay

giropay is a standard founded by the German banks Sparkasse, Postbank, Volks- und Raiffeisen Banken. The giropay online transfer has a number of advantages for merchants. Firstly giropay provides the vendor with a guarantee for payments of up to 10,000 euros; secondly the transfer is a prepayment which minimises the payment term. Finally the customer is using the familiar and trusted online banking of its own credit institution, just the same as with online banking.

In the first step the customer chooses the giropay payment method at the checkout of the online shop and selects its credit institution. The customer is then connected directly to its Sparkasse/bank and logs on as normal using a PIN. A pre-completed transfer form then appears. The customer need only enter their TAN to confirm the payment.

With online banking, the data disclosed in the online transfer is encrypted with SSL (Secure Sockets Layer) to prevent manipulation.


Logo

Info

giropay is an online bank transfer with PIN and TAN that provides you with access to nearly 40 million online banking users in Germany in Austria. Additionally to the full 100% payment guarantee the use of giropay is relatively low priced.

TypePayments by Online Bank Transfer

 

Further information can be found on the webpage of giropay (http://www.giropay.de).


Process flow chart

giropay process flow


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 giropay interface

To initiate a payment with giropay, please use the following URL:

 

Notice: Please observe that a connection via iFrame is not possible due to existing regulations and will be technically prevented.

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:

Oops, it seems that you need to place a table or a macro generating a table within the Table Filter macro.

The table is being loaded. Please wait for a bit ...

KeyRESTFormatCNDDescriptionBeschreibung

MerchantID

BasicAuth.Username

ans..30

M

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

HändlerID, die von Computop vergeben wird. Dieser Parameter ist zusätzlich auch unverschlüsselt zu übergeben.

KeyRESTFormatCNDDescriptionBeschreibung
TransID"transactionId": "..."

ans..64

MTransactionID provided by you which should be unique for each paymentIhre eigene TransaktionsID, die für jede Zahlung eindeutig sein muss

Key

REST

Format

CND

Description

Beschreibung

RefNr

"referenceNumber": "..."

ans..30

OC

Unique reference number.

In case of PPRO: Only characters a-zA-Z0-9,-_ are allowed, format ans..40.

Eindeutige Referenznummer.

Bei PPRO: Nur die Zeichen a-zA-Z0-9,-_ sind erlaubt, Format ans..40.

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

Betrag in der kleinsten Währungseinheit (z.B. EUR Cent). Bitte wenden Sie sich an den Computop Helpdesk, wenn Sie Beträge < 100 (kleinste Währungseinheit) buchen möchten.

KeyRESTFormatCNDDescriptionBeschreibung
Currency"amount": { "currency": "..."}

a3

M

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

Währung, drei Zeichen DIN / ISO 4217, z.B. EUR, USD, GBP. Hier eine Übersicht: A1 Währungstabelle

KeyRESTFormatCNDDescriptionBeschreibung

MAC

---

an64

M
Hash Message Authentication Code (HMAC) with SHA-256 algorithm. Details can be found here:
Hash Message Authentication Code (HMAC) mit SHA-256-Algorithmus. Details finden Sie hier:

Key

REST

Format

CND

Description

Beschreibung

OrderDesc

"order": {"description": "..."}

ans..768

M

Description of purchased goods, unit prices etc.

Please note: The first 27 characters appear on the customer-account statement. You can view the full data in Computop Analytics.

Beschreibung der gekauften Waren, Einzelpreise etc.

Bitte beachten Sie: Die ersten 27 Zeichen erscheinen auf dem Kontoauszug des Kunden. In Computop Analytics können Sie die kompletten Daten einsehen.

KeyRESTFormatCNDDescriptionBeschreibung
UserData"metadata[userData]": "..."

ans..1024

O

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

Wenn beim Aufruf angegeben, übergibt das Paygate die Parameter mit dem Zahlungsergebnis an den Shop.

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

(info) 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. Therefore ensure to check the "code"-value which indicates success/failure of the action. Only a result of "code=00000000" should be considered successful.

Vollständige URL, die das Paygate aufruft, wenn die Zahlung erfolgreich war. Die URL darf nur über Port 443 aufgerufen werden. Diese URL darf keine Parameter enthalten: Um Parameter durchzureichen nutzen Sie stattdessen den Parameter UserData.

(info) Allgemeine Hinweise:

  • Wir empfehlen, den Parameter "response=encrypt" zu verwenden, um eine verschlüsselte Antwort von Paygate zu erhalten
  • Betrüger könnten das verschlüsselte DATA-Element kopieren, welches an URLFailure gesendet wurde, und betrügerisch dasselbe DATA an URLSuccess senden. Überprüfen Sie daher unbedingt den "code"-Wert des DATA-Elements. Nur eine Antwort mit "code=00000000" sollte als erfolgreich angesehen werden.

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

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

Vollständige URL, die das Paygateaufruft, wenn die Zahlung gescheitert ist. Die URL darf nur über Port 443 aufgerufen werden. Diese URL darf keine Parameter enthalten: Um Parameter durchzureichen nutzen Sie stattdessen den Parameter UserData.

(info) Allgemeine Hinweise:

  • Wir empfehlen, den Parameter "response=encrypt" zu verwenden, um eine verschlüsselte Antwort von Paygate zu erhalten
  • Betrüger könnten das verschlüsselte DATA-Element kopieren, welches an URLFailure gesendet wurde, und betrügerisch dasselbe DATA an URLSuccess/URLNotify senden. Überprüfen Sie daher unbedingt den "code"-Wert des DATA-Elements. Nur eine Antwort mit "code=00000000" sollte als erfolgreich angesehen werden.

KeyRESTFormatCNDDescriptionBeschreibung
Response

---

a7

O

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

Die Status-Rückmeldung, die das Paygate an URLSuccess und URLFailure sendet, sollte verschlüsselt werden. Dazu übergeben Sie den Parameter Response=encrypt.

KeyRESTFormatCNDDescriptionBeschreibung
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 UserData parameter instead.

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

Vollständige URL, die das Paygate aufruft, um den Shop zu benachrichtigen. Die URL darf nur über Port 443 aufgerufen werden. Sie darf keine Parameter enthalten: Nutzen Sie stattdessen den Parameter UserData.

(info) Allgemeine Hinweise:

  • Wir empfehlen, den Parameter "response=encrypt" zu verwenden, um eine verschlüsselte Antwort von Paygate zu erhalten
  • Betrüger könnten das verschlüsselte DATA-Element kopieren, welches an URLFailure gesendet wurde, und betrügerisch dasselbe DATA an URLSuccess/URLNotify senden. Überprüfen Sie daher unbedingt den "code"-Wert des DATA-Elements. Nur eine Antwort mit "code=00000000" sollte als erfolgreich angesehen werden.

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

Um Doppelzahlungen (z.B. durch ETM) zu vermeiden, übergeben Sie einen alphanumerischen Wert, der Ihre Transaktion oder Aktion identifiziert und nur einmal vergeben werden darf. Falls die Transaktion oder Aktion mit derselben ReqID erneut eingereicht wird, führt das Computop Paygate keine Zahlung oder weitere Aktion aus, sondern gibt nur den Status der ursprünglichen Transaktion oder Aktion zurück.

Bitte beachten Sie, dass das Computop Paygate für die erste initiale Aktion (Authentifizierung/Autorisierung) einen abgeschlossenen Transaktionsstatus haben muss. Dies gilt nicht für 3-D Secure Authentifizierungen, die durch einem Timeout beendet werden. Der Status 3-D Secure Timeout gilt nicht als abgeschlossener Status, bei dem ReqID-Funktionalität am Paygate nicht greift. Einreichungen mit identischer ReqID auf einen offenen Status werden regulär verarbeitet.

Hinweis: Bitte beachten Sie, dass eine ReqID nur 12 Monate gültig ist, danach wird sie vom Paygate gelöscht.

Key

REST

Format

CND

Description

Beschreibung

SellingPoint

"payment": {"giropay": {"sellingPoint": "..."}}

ans..50

C

Only with PPRO: Selling point

Nur bei PPRO: Verkaufsstelle

Service

"payment": {"giropay": {"service": "..."}}

ans..50

C

Only with PPRO: products or service sold

Nur bei PPRO: verkaufte Produkte oder Dienstleistungen

Channel

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

ans..64

OC

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.

Nur bei PPRO: Konfigurationskanal des PPRO-Vertrags (Account und ContractID sind im System hinterlegt). Wenn vorhanden, überschreibt er eventuell im System hinterlegten Channel.
Language"language": "..."a2OOnly with PPRO: 2-letter language code (e.g.. de) that should be preferred when presenting payment pages to the consumerNur bei PPRO: 2-stelliger Sprachcode (z.B. de), der für die Zahlungsseiten für den Kunden bevorzugt werden soll

AccOwner

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

a3..50

C

Only with PPRO: Name of the card holder in the format
<first name><space><last name><space>

Nur bei PPRO: Name des Kontoinhabers im Format <Vorname><Leerzeichen><Nachname><Leerzeichen>

Scheme

"payment": {"giropay": {"scheme": "..."}}

enum

O

Defines the scheme: „gir“ or „eps“

Gibt das Schema vor: „gir“ oder „eps“

BIC

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

ans..11

O

Bank Identifier Code

Bank Identifier Code

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

Ein einzelner Wert, der von Ihnen gesetzt werden kann, um Informationen wieder unverschlüsselt in der Antwort bzw. im Notify zurückzugeben, z.B. die MID.

Da der "Plain"-Parameter Teil des verschlüsselten "Data" im Computop Paygate ist, ist dieser vor Manipulationen geschützt. 

KeyRESTFormatCND

Description

Beschreibung
Custom"metadata": "..."

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 samples here: Custom

Der "Custom"-Parameter wird vor der Verschlüsselung an den Aufruf angehängt und ist Teil des verschlüsselten "Data" im Computop Paygate Aufruf. Dadurch ist der Wert gegen Manipulation geschützt. 

Der Custom-Wert wird dann in Klartext an die Computop Paygate-Antwort angehängt und dabei wird "|" durch "&" ersetzt. Dadurch können Sie einen Custom-Wert übergeben und bekommen mehrere Key-Value-Paare zu Ihrer eigenen Verwendung in der Antwort zurück.

Hier finden Sie ein Beispiel: Custom

Key

REST

Format

CND

Description

Beschreibung

expirationTime

"expirationTime": "..."

ans..19

O

Timestamp for the end time of the transaction processing, specified in UTC.

Format: YYYY-MM-ddTHH:mm:ss

Zeitstempel für den Endzeitpunkt der Transaktionsverarbeitung, Angabe in UTC.

Format: YYYY-MM-ddTHH:mm:ss

IBAN

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

ans..34

C

Only for EVO: International Bank Account Number (mandatory for credit function and account check via EVO)

Nur bei EVO: International Bank Account Number (bei Gutschriftenfunktion und bei Account Prüfung über EVO Pflicht)

Capture

 "capture": {"auto": "Yes"}
"capture": {"manual": "Yes"}

an..6

M

Determines the type and time of capture.

Capture Mode
Comments
AUTOCapturing immediately after authorisation (default value).
MANUALCapturing made by the merchant. Capture is normally initiated at time of delivery.

Bestimmt Art und Zeitpunkt der Buchung (engl. Capture).

BuchungsartKommentar
AUTOBuchung sofort nach Autorisierung (Standardwert).
MANUALBuchung erfolgt durch den Händler - in der Regel die Buchung zum Zeitpunkt der Warenauslieferung bzw. Leistungserbringung.

ShoppingBasketCategory

 "payment": {"giropay": {"basketCategory": "..." }}

ans..32

O

Categorizes the shopping basket:

„DIGITAL“ for shopping baskets with solely digital goods

„PHYSICAL“ for shopping baskets with solely physical goods

„MIXED“ for shopping baskets with digital and physical goods

"ANONYMOUS_DONATION": The sopping basket solely is an anonymous donation

"AUTHORITIES_PAYMENT": The sopping basket solely contains  payments for authorities

Kategorisiert den Warenkorb:

„DIGITAL“ für Warenkörbe mit ausschließlich digitalen Gütern

„PHYSICAL“ für Warenkörbe mit ausschließlich physischen Gütern

„MIXED“ für Warenkörbe mit sowohl digitalen als auch physischen Gütern

"ANONYMOUS_DONATION": Beim Warenkorb handelt es sich ausschließlich um eine anonyme Spende

"AUTHORITIES_PAYMENT": Beim Warenkorb handelt es sich ausschließlich um Behördenzahlungen

DeliveryMethod

 "payment": {"giropay": {"deliveryMethod": "..." }}

ans..12

O

Delivery place STANDARD, PACKSTATION or STORE_PICKUP. The default value is STANDARD.

STANDARD: The goods will be delivered to a normal postal address.

PACKSTATION: The goods will be delivered to a packstation.

STORE_PICKUP: The goods will be picked-up within a branch store.

For express checkouts this field always has the value STANDARD and will not be updated depending on selected delivery option.

Lieferort: STANDARD, PACKSTATION oder STORE_PICKUP. Der Standardwert ist STANDARD.

STANDARD: Die Güter werden an eine gewöhnliche Postadresse geliefert.

PACKSTATION: Die Güter werden an eine Packstation geliefert.

STORE_PICKUP: Die Güter werden in der Filiale abgeholt.

Dieses Feld enthält bei Express-Checkouts immer den Wert STANDARD und wird nicht anhand der gewählten Lieferoption aktualisiert.

sdFirstName

 "shipping": {"consumer": { "firstName": "..." }}

ans..50

C

First name in the delivery address. Mandatory, if ShoppingBasketCategory IS NOT „AUTHORITIES_PAYMENT“ and IS NOT „ANONYMOUS_DONATION“

Vorname in der Lieferanschrift. Pflicht, wenn ShoppingBasketCategory IST NICHT „AUTHORITIES_PAYMENT“ und IST NICHT „ANONYMOUS_DONATION“

sdLastName

 "shipping": {"consumer": { "lastName": "..." }}

ans..50

C

Surname in the delivery address. Mandatory, if ShoppingBasketCategory IS NOT „AUTHORITIES_PAYMENT“ and IS NOT „ANONYMOUS_DONATION“

Nachname in der Lieferanschrift. Pflicht, wenn ShoppingBasketCategory IST NICHT „AUTHORITIES_PAYMENT“ und IST NICHT „ANONYMOUS_DONATION“

sdCompany

 "shipping": {"business": { "companyLegalName": "..." }}

ans..100

O

Company name in the delivery address

Firmenname in der Lieferanschrift

sdAddressAddition

 "shipping": {"addressInfo": { "addressLine2": "..." }}

ans..30

O

Address addition in the delivery address

Adresszusatz in der Lieferanschrift

sdStreet

 "shipping": {"addressInfo": {"addressLine1": {"street": "..." }}}

ans..100

C

Street name in the delivery address

Mandatory, if ShoppingBasketCategory IS NOT "DIGITAL" and IS NOT "AUTHORITIES_PAYMENT" and IS NOT "ANONYMOUS_DONATION"

Straßenname in der Lieferanschrift

Pflicht, wenn ShoppingBasketCategory IST NICHT "DIGITAL" und IST NICHT "AUTHORITIES_PAYMENT" und IST NICHT "ANONYMOUS_DONATION"

sdStreetNr

 "shipping": {"addressInfo": {"addressLine1": {"streetNumber": "..." }}}

ans..8

C

Street number in the delivery address

Mandatory, if ShoppingBasketCategory IS NOT "DIGITAL" and IS NOT "AUTHORITIES_PAYMENT" and IS NOT "ANONYMOUS_DONATION"

Hausnummer in der Lieferanschrift

Pflicht, wenn ShoppingBasketCategory IST NICHT "DIGITAL" und IST NICHT "AUTHORITIES_PAYMENT" und IST NICHT "ANONYMOUS_DONATION"

sdZip

 "shipping": {"addressInfo": { "postalCode": "..." }}

n..5

C

Postcode in the delivery address

Mandatory, if ShoppingBasketCategory IS NOT "DIGITAL" and IS NOT "AUTHORITIES_PAYMENT" and IS NOT "ANONYMOUS_DONATION"

Postleitzahl in der Lieferanschrift

Pflicht, wenn ShoppingBasketCategory IST NICHT "DIGITAL" und IST NICHT "AUTHORITIES_PAYMENT" und IST NICHT "ANONYMOUS_DONATION"

sdCity

 "shipping": {"addressInfo": { "city": "..." }}

ans..100

C

Town/city in the delivery address

Mandatory, if ShoppingBasketCategory IS NOT "DIGITAL" and IS NOT "AUTHORITIES_PAYMENT" and IS NOT "ANONYMOUS_DONATION"

Ort in der Lieferanschrift

Pflicht, wenn ShoppingBasketCategory IST NICHT "DIGITAL" und IST NICHT "AUTHORITIES_PAYMENT" und IST NICHT "ANONYMOUS_DONATION"

sdCountryCode

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

an2

C

Country code in the delivery address

Mandatory, if ShoppingBasketCategory IS NOT "DIGITAL" and IS NOT "AUTHORITIES_PAYMENT" and IS NOT "ANONYMOUS_DONATION"

Ländercode in der Lieferanschrift

Pflicht, wenn ShoppingBasketCategory IST NICHT "DIGITAL" und IST NICHT "AUTHORITIES_PAYMENT" und IST NICHT "ANONYMOUS_DONATION"

sdEMail

 "shipping": {"contactInfo": { "email": "..." }}

ans..100

C

Email address of the receiver

mandatory, if ShoppingBasketCategory = „DIGITAL“

E-Mail-Adresse des Empfängers

Pflicht, wenn ShoppingBasketCategory = „DIGITAL“

MinAge

 "payment": {"giropay": {"minAge": "..." }}

n..3

O

Using the field minimum age will result in the single option "giropay-Login" for the customers, because an age verification at the time is solely possible with an existing giropay account. Minimum age in years. 

Durch Nutzung des Feldes Mindestalter ergibt sich für den Kunden nur die Option „giropay-Login“, da eine Altersüberprüfung zu diesem Zeitpunkt nur mit einem bestehenden giropay-Konto möglich ist. Mindestalter in Jahren.

Parameters for online transfers with giropay


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.

RESTFormatCNDDescription

"paymentId": "..."

an32M

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

"_Links.self.type": "..."an..20M

"application/json"

"_Links.redirect.href": "..."an..1024MMerchant needs to redirect consumer to this URL to complete payment
"_Links.redirect.type": "..."an..20M"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:

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

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

Oops, it seems that you need to place a table or a macro generating a table within the Table Filter macro.

The table is being loaded. Please wait for a bit ...

KeyFormatCNDDescriptionBeschreibung

mid

ans..30

M

MerchantID, assigned by Computop

HändlerID, die von Computop vergeben wird

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

Vom Paygate vergebene ID für die Zahlung; z.B. zur Referenzierung in Batch-Dateien sowie im Capture- oder Credit-Request.

KeyFormatCNDDescriptionBeschreibung
XID

an32

M

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

Vom Paygate vergebene ID für alle einzelnen Transaktionen (Autorisierung, Buchung, Gutschrift), die für eine Zahlung durchgeführt werden

KeyFormatCNDDescriptionBeschreibung
TransID

ans..64

MTransactionID provided by you which should be unique for each paymentIhre eigene TransaktionsID, die für jede Zahlung eindeutig sein muss

KeyFormatCNDDescriptionBeschreibung
Status

a..50

M

OK (URLSuccess) or FAILED (URLFailure)

OK (URLSuccess) oder FAILED (URLFailure)

KeyFormatCNDDescriptionBeschreibung
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!
Nähere Beschreibung bei Ablehnung der Zahlung. Bitte nutzen Sie nicht den Parameter Description, sondern Code für die Auswertung des Transaktionsstatus!

KeyFormatCNDDescriptionBeschreibung
Code

an8

M

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

Fehlercode gemäß Paygate Antwort-Codes (A4 Fehlercodes)

Key

Format

CND

Description

Beschreibung

RefNr

ans..30

OC

Unique reference number.

In case of PPRO: Only characters a-zA-Z0-9,-_ are allowed, format ans..40.

Eindeutige Referenznummer.

Bei PPRO: Nur die Zeichen a-zA-Z0-9,-_ sind erlaubt, Format ans..40.

KeyFormatCNDDescriptionBeschreibung
UserData

ans..1024

O

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

Wenn beim Aufruf angegeben, übergibt das Paygate die Parameter mit dem Zahlungsergebnis an den Shop.

KeyFormatCNDDescriptionBeschreibung

MAC

an64

M
Hash Message Authentication Code (HMAC) with SHA-256 algorithm. Details can be found here:
Hash Message Authentication Code (HMAC) mit SHA-256-Algorithmus. Details finden Sie hier:

Key

Format

CND

Description

Beschreibung

PaymentPurpose

ans..26

C

Only with PPRO: Purpose of payment

Nur bei PPRO: Zahlungszweck

PaymentGuarantee

a..12

C

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.

Nur bei PPRO: NONE= keine Zahlungsgarantie,

VALIDATED= Kundenkonto valide, aber keine Zahlungsgarantie, FULL= Zahlungsgarantie

Hinweis: Dieser Parameter wird nur zurückgegeben, falls der Status=OK ist.

ErrorText

ans..128

C

Only with PPRO: Detailed PPRO error message.

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

Nur bei PPRO: detaillierte PPRO Fehlermeldung.

Hinweis: Wird nur bei Status=FAILED zurückgegeben. Nutzung nur in Abstimmung mit dem Computop Helpdeskmöglich.

TransactionID

an..20

O

Unique transaction number from PPRO

Eindeutige Transaktionsnummer bei PPRO

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

Ein einzelner Wert, der von Ihnen gesetzt werden kann, um Informationen wieder unverschlüsselt in der Antwort bzw. im Notify zurückzugeben, z.B. die MID.

Da der "Plain"-Parameter Teil des verschlüsselten "Data" im Computop Paygate ist, ist dieser vor Manipulationen geschützt. 

KeyFormatCND

Description

Beschreibung
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 samples here: Custom

Der "Custom"-Parameter wird vor der Verschlüsselung an den Aufruf angehängt und ist Teil des verschlüsselten "Data" im Computop Paygate Aufruf. Dadurch ist der Wert gegen Manipulation geschützt. 

Der Custom-Wert wird dann in Klartext an die Computop Paygate-Antwort angehängt und dabei wird "|" durch "&" ersetzt. Dadurch können Sie einen Custom-Wert übergeben und bekommen mehrere Key-Value-Paare zu Ihrer eigenen Verwendung in der Antwort zurück.

Hier finden Sie ein Beispiel: Custom

Result parameters for URLNotify, URLSuccess and URLFailure in case of giropay


Capture

Captures are possible via a Server-to-Server connection. To carry out a Capture for giropay via a Server-to-Server connection, please use the following URL:


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:


Oops, it seems that you need to place a table or a macro generating a table within the Table Filter macro.

The table is being loaded. Please wait for a bit ...

KeyRESTFormatCNDDescriptionBeschreibung

MerchantID

BasicAuth.Username

ans..30

M

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

HändlerID, die von Computop vergeben wird. Dieser Parameter ist zusätzlich auch unverschlüsselt zu übergeben.

KeyRESTFormatCNDDescriptionBeschreibung
PayID"paymentId": "..."

an32

M

ID assigned by Paygate for the payment to be captured

Vom Paygate vergebene ID für die zu buchende Zahlung

Key

REST

Format

CND

Description

Beschreibung

TransID

"transactionId": "..."

ans..20

M

TransactionID which should be unique for each payment. The underscore may not be used.TransaktionsID, die für jede Zahlung eindeutig sein muss. Es darf kein Unterstrich verwendet werden.
RefNr"referenceNumber": "..."ns..30OMerchant reference number: here a separate reference number, e.g. an invoice number, can be transferredReferenznummer des Händlers: hier kann eine separate Referenznummer wie z.B. Rechnungsnummer übergeben werden

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

Betrag in der kleinsten Währungseinheit (z.B. EUR Cent). Bitte wenden Sie sich an den Computop Helpdesk, wenn Sie Beträge < 100 (kleinste Währungseinheit) buchen möchten.

KeyRESTFormatCNDDescriptionBeschreibung

MAC

---

an64

M
Hash Message Authentication Code (HMAC) with SHA-256 algorithm. Details can be found here:
Hash Message Authentication Code (HMAC) mit SHA-256-Algorithmus. Details finden Sie hier:

KeyRESTFormatCNDDescriptionBeschreibung
UserData"metadata[userData]": "..."

ans..1024

O

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

Wenn beim Aufruf angegeben, übergibt das Paygate die Parameter mit dem Zahlungsergebnis an den Shop.

Key

REST

Format

CND

Description

Beschreibung

Note


ans..37

O

Text that will we displayed as reason for payment to the customer

Text, der dem Kunden im Verwendungszweck angezeigt wird

Parameters for giropay captures


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

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

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

Oops, it seems that you need to place a table or a macro generating a table within the Table Filter macro.

The table is being loaded. Please wait for a bit ...

KeyRESTFormatCNDDescriptionBeschreibung

mid

"merchantId": "..."

ans..30

M

MerchantID, assigned by Computop

HändlerID, die von Computop vergeben wird

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

Vom Paygate vergebene ID für die Zahlung; z.B. zur Referenzierung in Batch-Dateien sowie im Capture- oder Credit-Request.

KeyRESTFormatCNDDescriptionBeschreibung
XID"xId": "..."

an32

M

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

Vom Paygate vergebene ID für alle einzelnen Transaktionen (Autorisierung, Buchung, Gutschrift), die für eine Zahlung durchgeführt werden

Key

REST

Format

CND

Description

Beschreibung

TransID

"transactionId": "..."

ans..20

M

TransactionID which should be unique for each payment

Transaktions-ID, die für jede Zahlung eindeutig sein muss
Status

"status": "OK"

"status": "CAPTURE_REQUEST"

"status": "FAILED"

a..50MOK, CAPTURE_REQUEST or FAILEDOK, CAPTURE_REQUEST oder FAILED

KeyRESTFormatCNDDescriptionBeschreibung
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!
Nähere Beschreibung bei Ablehnung der Zahlung. Bitte nutzen Sie nicht den Parameter Description, sondern Code für die Auswertung des Transaktionsstatus!

KeyRESTFormatCNDDescriptionBeschreibung
Code"code": ...

an8

M

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

Fehlercode gemäß Paygate Antwort-Codes (A4 Fehlercodes)

KeyRESTFormatCNDDescriptionBeschreibung
refnr"referenceNumber": "..."

ns..30

O

Merchant’s unique reference number

Eindeutige Referenznummer des Händlers

KeyRESTFormatCNDDescriptionBeschreibung
UserData"metadata[userData]": "..."

ans..1024

O

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

Wenn beim Aufruf angegeben, übergibt das Paygate die Parameter mit dem Zahlungsergebnis an den Shop.

Key

REST

Format

CND

Description

Beschreibung

TransactionID


ans36

O

Unique transaction-ID of this capture (UUID). The value is assigned by the giropay-System.

Eindeutige Transaktions-ID dieser Buchung (UUID). Der Wert wird durch das giropay-System vergeben.

Result parameters for giropay captures


Credit with reference

Notice: Please observe that credits are possible only via PPRO.

Credits (refunds) are possible via a Server-to-Server connection. The Computop Paygate permits only credits for giropay that reference a previously made transaction via Computop Paygate. 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, 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:

Oops, it seems that you need to place a table or a macro generating a table within the Table Filter macro.

The table is being loaded. Please wait for a bit ...

KeyRESTFormatCNDDescriptionBeschreibung

MerchantID

BasicAuth.Username

ans..30

M

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

HändlerID, die von Computop vergeben wird. Dieser Parameter ist zusätzlich auch unverschlüsselt zu übergeben.

KeyRESTFormatCNDDescriptionBeschreibung
PayID"paymentId": "..."

an32

M

ID assigned by Paygate for the payment to be credited

Vom Paygate vergebene ID für die gutzuschreibende Zahlung

KeyRESTFormatCNDDescriptionBeschreibung
TransID"transactionId": "..."

ans..64

MTransactionID provided by you which should be unique for each paymentIhre eigene TransaktionsID, die für jede Zahlung eindeutig sein muss

KeyRESTFormatCNDDescriptionBeschreibung

MAC

---

an64

M
Hash Message Authentication Code (HMAC) with SHA-256 algorithm. Details can be found here:
Hash Message Authentication Code (HMAC) mit SHA-256-Algorithmus. Details finden Sie hier:

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

Betrag in der kleinsten Währungseinheit (z.B. EUR Cent). Bitte wenden Sie sich an den Computop Helpdesk, wenn Sie Beträge < 100 (kleinste Währungseinheit) buchen möchten.

Key

REST

Format

CND

Description

Beschreibung

Note


ans..37

O

Free text field that appears on the bank statement in the payment reference (DIRECT_SALE only).

Freitextfeld, das auf dem Kontoauszug in der Zahlungsreferenz erscheint (nur DIRECT_SALE).

Reason


ans..1024

O

Reason for the refund
MERCHANT_TECHNICAL_PROBLEM: Technical problem during processing.
MERCHANT_CAN_NOT_DELIVER_GOODS: Merchant cannot deliver the goods.
REFUND_OBLIGINGNESS: Refund as a gesture of goodwill.
CUSTOMER_RETURN_GOODS: Refund due to return of goods.

Grund für die Gutschrift:

MERCHANT_TECHNICAL_PROBLEM: Technisches Problem während der Verarbeitung.
MERCHANT_CAN_NOT_DELIVER_GOODS: Der Händler kann die Ware nicht liefern.
REFUND_OBLIGINGNESS: Rückerstattung aus Kulanz.
CUSTOMER_RETURN_GOODS: Rückerstattung aufgrund der Rücksendung der Ware.

Parameters for credits of giropay payments

 

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

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

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

Oops, it seems that you need to place a table or a macro generating a table within the Table Filter macro.

The table is being loaded. Please wait for a bit ...

KeyRESTFormatCNDDescriptionBeschreibung

mid

"merchantId": "..."

ans..30

M

MerchantID, assigned by Computop

HändlerID, die von Computop vergeben wird

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

Vom Paygate vergebene ID für die Zahlung; z.B. zur Referenzierung in Batch-Dateien sowie im Capture- oder Credit-Request.

KeyRESTFormatCNDDescriptionBeschreibung
XID"xId": "..."

an32

M

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

Vom Paygate vergebene ID für alle einzelnen Transaktionen (Autorisierung, Buchung, Gutschrift), die für eine Zahlung durchgeführt werden

KeyRESTFormatCNDDescriptionBeschreibung
TransID"transactionId": "..."

ans..64

MTransactionID provided by you which should be unique for each paymentIhre eigene TransaktionsID, die für jede Zahlung eindeutig sein muss

Key

REST

Format

CND

Description

Beschreibung

Status

"status": "OK"

"status": "FAILED"

"status": "AUTHORIZE_REQUEST"

a..30

M

OK or FAILED and only in the case of PPRO AUTHORIZE_REQUEST

OK oder FAILED und nur bei PPRO AUTHORIZE_REQUEST

KeyRESTFormatCNDDescriptionBeschreibung
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!
Nähere Beschreibung bei Ablehnung der Zahlung. Bitte nutzen Sie nicht den Parameter Description, sondern Code für die Auswertung des Transaktionsstatus!

KeyRESTFormatCNDDescriptionBeschreibung
Code"code": ...

an8

M

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

Fehlercode gemäß Paygate Antwort-Codes (A4 Fehlercodes)

Key

REST

Format

CND

Description

Beschreibung

RefNr

"referenceNumber": "..."

ans..30

OC

Merchant’s unique reference number.

In case of PPRO: Only characters a-zA-Z0-9,-_ are allowed, format ans..40.

Referenznummer des Händlers.

Bei PPRO: Nur die Zeichen a-zA-Z0-9,-_ sind erlaubt, Format ans..40.

ErrorText"errorText": "..."ans..128OC

Only with PPRO: Detailed PPRO error message.

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

Nur bei PPRO: detaillierte PPRO-Fehlermeldung.

Hinweis: Wird nur bei Status=FAILED zurückgegeben. Nutzung nur in Abstimmung mit dem Computop Helpdesk möglich.

Result parameters for credits of giropay 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 within the data set (Record) for executing a giropay payment and which information can be found within the response file about the payment status.

Notice: Please note that Batch processing for giropay 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:

Oops, it seems that you need to place a table or a macro generating a table within the Table Filter macro.

The table is being loaded. Please wait for a bit ...

Action

Version

Description

Beschreibung

Credit

1.0 / 2.0

Standard version without return of parameter Code

Standardversion ohne Rückgabe von Parameter Code


1.x / 2.x

with RefNr (valid for all versions other than 1.0)

mit RefNr (gilt für alle Versionen außer 1.0)

Description of the possible batch versions


The structure for a giropay payment within a Batch file to be submitted is the following:

HEAD,<MerchantID>,<Date>,<Version>
GIROPAY,Credit,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID>
FOOT,<CountRecords>,<SumAmount>

Example for Master MID function:

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:

Oops, it seems that you need to place a table or a macro generating a table within the Table Filter macro.

The table is being loaded. Please wait for a bit ...

Key

Format

CND

Description

Beschreibung

Type

a..11

M

HEAD for Header, FOOT for Footer, GIROPAY for giropay

HEAD für Header, FOOT für Footer, GIROPAY für giropay

Action

a..20

M

The parameter Action defines the type of transaction:

Credit

Der Action-Parameter definiert die Art der Transaktion:

Credit (Gutschrift)

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

Betrag in der kleinsten Währungseinheit (z.B. EUR Cent). Bitte wenden Sie sich an den Computop Helpdesk, wenn Sie Beträge < 100 (kleinste Währungseinheit) buchen möchten.

KeyFormatCNDDescriptionBeschreibung
Currency

a3

M

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

Währung, drei Zeichen DIN / ISO 4217, z.B. EUR, USD, GBP. Hier eine Übersicht: A1 Währungstabelle

KeyFormatCNDDescriptionBeschreibung
TransID

ans..64

MTransactionID provided by you which should be unique for each paymentIhre eigene TransaktionsID, die für jede Zahlung eindeutig sein muss

Key

Format

CND

Description

Beschreibung

RefNr

ans..30

O

Unique reference number.

In case of PPRO: Only characters a-zA-Z0-9,-_ are allowed, format ans..40.

Eindeutige Referenznummer.

Bei PPRO: Nur die Zeichen a-zA-Z0-9,-_ sind erlaubt, Format ans..40.

KeyFormatCNDDescriptionBeschreibung
PayID

an32

M

ID assigned by Paygate for this transaction

Vom Paygate vergebene ID für diese Transaktion

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>
GIROPAY,Credit,<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):

Oops, it seems that you need to place a table or a macro generating a table within the Table Filter macro.

The table is being loaded. Please wait for a bit ...

Key

Format

CND

Description

Beschreibung

Action

a..20

M

The parameter Action defines the type of transaction: Credit

Der Action-Parameter definiert die Art der Transaktion: Credit (Gutschrift)

KeyFormatCNDDescriptionBeschreibung
PayID

an32

M

ID assigned by Paygate for this transaction

Vom Paygate vergebene ID für diese Transaktion

KeyFormatCNDDescriptionBeschreibung
Status

a..50

M

OK (URLSuccess) or FAILED (URLFailure)

OK (URLSuccess) oder FAILED (URLFailure)

KeyFormatCNDDescriptionBeschreibung
Code

an8

M

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

Fehlercode gemäß Paygate Antwort-Codes (A4 Fehlercodes)

Description of result parameters within the record for Batch files