Introduction

Giropay is a German payment method based on online banking allowing customers to use direct transfers from their bank account.

Hosted Payment Page Integration

In addition to all standard mandatory fields, it is also recommended to include Giropay specific fields, as listed below.

Field NameTypeDescription
checkoutoptionMandatorySet the value for this parameter to ‘combinedpage’
full_bypassOptionalWhen using your own input form set this parameter to 'false'
paymentMethodOptional Set the value = 'giropay'.
If you do not submit this parameter, our Gateway will display a hosted payment selection page to allow your customer to choose from all the payment methods activated for your store.
customParam_purposeMandatoryUsed this parameter (27 characters max) to set information which should be shown on your customers’ bank statement.
If not submitted, the Gateway populates a value sent in invoicenumberor if not available - a value in oid
Characters must comply with the SEPA character set, thus only characters of the limited SWIFT Latin characters set are allowed:
• a b c d e f g h i j k l m n o p q r s t u v w x y z
• A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
• 0 1 2 3 4 5 6 7 8 9
• ' : ? , - ( + . ) / |
• space
customParam_shoppingCartTypeMandatoryType of the shopping cart. The available values are:
PHYSICAL = All goods in the cart are of a physical nature (shipping address details mandatory),
DIGITAL = All goods in the cart are of a digital nature (shipping address details mandatory, but no shipping required),
MIXED = The cart contains both physical and digital goods. This is the default value should it not be given (shipping address details mandatory),
ANONYMOUS_DONATION = This is an anonymous donation and not a commercial transaction (no shipping address data necessary),
AUTHORITIES_PAYMENT = This is a payment for local authorities (no shipping address data necessary).
Please note, that this parameter is currently an optional field, however by the end of 2023 it will become a mandatory field in conjunction with the shipping address details.
sfnameMandatoryShipping / customer's first name
Alphanumeric characters, incl. spaces, and dashes limited to 96
slnameMandatoryShipping / customer's last name
Alphanumeric characters, incl. spaces, and dashes limited to 96
snameMandatoryShipping / Company name
Alphanumeric characters, incl. spaces, and dashes limited to 96
saddr1MandatoryShipping address line 1
Alphanumeric characters, incl. spaces, and dashes limited to 96
saddr2MandatoryShipping address line 2
Alphanumeric characters, incl. spaces, and dashes limited to 96
scityMandatoryShipping city
Alphanumeric characters, incl. spaces, and dashes limited to 96
scountryMandatoryShipping country
2 letter ISO country code
szipMandatoryShipping ZIP or postal code
Alphanumeric characters, incl. spaces, and dashes limited to 24
semailMandatoryCustomer's email address
Alphanumeric characters limited to 254

Want a quick overview?