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.

Type

Payments by Online Bank Transfer

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

Process flow chart

giropay process flow

interface

Calling the giropay interface

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

giropay.aspx

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

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.

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 .	Beschreibung der gekauften Waren, Einzelpreise etc. Bitte beachten Sie: Die ersten 27 Zeichen erscheinen auf dem Kontoauszug des Kunden. In können Sie die kompletten Daten einsehen.

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": "..."	a2	O	Only with PPRO: 2-letter language code (e.g.. de) that should be preferred when presenting payment pages to the consumer	Nur 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

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

an..6

M

Determines the type and time of capture.

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

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

Buchungsart	Kommentar
AUTO	Buchung sofort nach Autorisierung (Standardwert).
MANUAL	Buchung erfolgt durch den Händler - in der Regel die Buchung zum Zeitpunkt der Warenauslieferung bzw. Leistungserbringung.

ShoppingBasketCategory

a..8

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

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

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

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

ans..100

O

Company name in the delivery address

Firmenname in der Lieferanschrift

sdAddressAddition

ans..30

O

Address addition in the delivery address

Adresszusatz in der Lieferanschrift

sdStreet

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

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

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

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

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

ans..100

C

Email address of the receiver

mandatory, if ShoppingBasketCategory = „DIGITAL“

E-Mail-Adresse des Empfängers

Pflicht, wenn ShoppingBasketCategory = „DIGITAL“

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

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.

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	Nur bei PPRO: detaillierte PPRO Fehlermeldung. Hinweis: Wird nur bei Status=FAILED zurückgegeben. Nutzung nur in Abstimmung mit dem möglich.
TransactionID	an..20	O	Unique transaction number from PPRO	Eindeutige Transaktionsnummer bei PPRO

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:

capture.aspx

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..30	O	Merchant reference number: here a separate reference number, e.g. an invoice number, can be transferred	Referenznummer des Händlers: hier kann eine separate Referenznummer wie z.B. Rechnungsnummer übergeben werden

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

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

M

OK, CAPTURE_REQUEST or FAILED

OK, CAPTURE_REQUEST oder FAILED

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 permits only credits for giropay that reference a previously made transaction via . 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:

credit.aspx

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

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

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

OC

Only with PPRO: Detailed PPRO error message.

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

Nur bei PPRO: detaillierte PPRO-Fehlermeldung.

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

Result parameters for credits of giropay payments

Batch processing via the 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:

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

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)

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.

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>

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)

Description of result parameters within the record for Batch files