1 About giropay

1.1 General information about giropay

Logo

InfoType
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.Payments by Online Bank Transfer

giropay is a standard founded by the German banks Sparkasse, Postbank, and 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.

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

1.2 Process flow chart

giropay process flow

2 1cs Online Payment System interface

2.1 Definitions

2.1.1 Data formats

FormatDescription
aalphabetical
asalphabetical with special characters
nnumeric
analphanumeric
ansalphanumeric with special characters
nsnumeric with special characters
boolboolean expression (true or false)
3fixed length with 3 digits/characters
..3variable length with maximum 3 digits/characters
enumenumeration of allowed values
dttmISODateTime (YYYY-MM-DDThh:mm:ss)

2.1.2 Abbreviations

AbbreviationDescriptionComment
CNDcondition 
MmandatoryIf a parameter is mandatory, then it must be present
OoptionalIf a parameter is optional, then it can be present, but it is not required
CconditionalIf 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.

2.2 Calling the giropay interface

To initiate a payment with giropay, call up the following URL:

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

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

Notice: For security reasons, the 1cs Online Payment System 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:

ParameterFormatCNDDescription
MerchantIDans..30MMerchantID, assigned by First Cash Solution. Additionally, this parameter must be passed in plain language too.
TransIDans..64MTransactionID which should be unique for each payment.  
RefNrns..30OCUnique reference number Only ASCII characters are allowed. Special characters such as (“umlauts”, …) are not permitted and may have to be replaced by ASCII characters (e.g. ü → ue, é → e, …).
Amountn..10MAmount in the smallest currency unit (e.g. EUR Cent) Please contact the helpdesk, if you want to capture amounts < 100 (smallest currency unit).
Currencya3MCurrency, three digits DIN / ISO 4217, e.g. EUR, USD, GBP. Please find an overview here: A1 Currency table EN
Macan64MHash Message Authentication Code (HMAC) with SHA-256 algorithm. Details can be found here: HMAC Authentication (Request) HMAC Authentication (Notify)
OrderDescans..768MDescription 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 First Cash Solution Analytics.
UserDataans..1024OIf specified at request, the 1cs Online Payment System forwards the parameter with the payment result to the shop
URLSuccessans..256MComplete URL which calls up the 1cs Online Payment System 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 the 1cs Online Payment System and shop, please use the parameter UserData. General notes: We recommend using the parameter “response=encrypt” to receive an encrypted response from 1cs Online Payment system 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.
URLFailureans..256MComplete URL which calls up the 1cs Online Payment System 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 the 1cs Online Payment System and shop, please use the parameter UserData. General notes: We recommend using the parameter “response=encrypt” to receive an encrypted response from 1cs Online Payment system 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.
Responsea7OStatus response sent by the 1cs Online Payment System to URLSuccess and URLFailure, should be encrypted. For this purpose, transmit Response=encrypt parameter.
URLNotifyans..256OComplete URL which the 1cs Online Payment System 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. General notes: We recommend using the parameter “response=encrypt” to receive an encrypted response from 1cs Online Payment system 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.
ReqIDans..32OTo 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, the 1cs Online Payment System will not carry out the payment, but will just return the status of the original transaction. Please note that the 1cs Online Payment system must have a completed transaction status for the first initial action. Submissions with identical ReqID on 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.
SchemeenumODefines the scheme: „gir“ or „eps“
BICans..11OBank Identifier Code
Plainans..50OA value to be set by the merchant to return some information unencrypted, e.g. the MID. As the “Plain” parameter is part of the encrypted “Data” in the 1cs online payment system, it is protected from manipulation.
Customans..1024OThe “Custom” parameter is appended to the call before encryption and is part of the encrypted “Data” in the 1cs OBS. This protects the value against manipulation by a consumer.

The custom value is then appended to the 1cs Online Payment System response in plain text with “|” replaced by “&”. This allows you to pass a custom value and get back multiple key-value pairs for your own use in the response.
expirationTimeans..19Otimestamp for the end time of the transaction processing, specified in UTC. Format: YYYY-MM-ddTHH:mm:ss

Parameters for online transfers with giropay

The following table gives the result parameters which 1cs Online Payment System 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:

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

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

ParameterFormatCNDDescription
MIDans..30MMerchantID, assigned by First Cash Solution
PayIDan32MID assigned by the 1cs Online Payment System for the payment, e.g. for referencing in batch files and in the capture or credit request.
XIDan32MID for all single transactions (authorisation, capture, credit note) for one payment assigned by 1cs Online Payment System
TransIDans..64MTransactionID provided by you which should be unique for each payment
Statusa..50MOK (URLSuccess) or FAILED (URLFailure)
Descriptionans..1024MFurther details in the event that payment is rejected. Please do not use the Description but the Code parameter for the transaction status analysis!
Coden8MError code according to the 1cs Online Payment System Response Codes (Error Codes)
RefNrans..30OCUnique reference number. Only ASCII characters are allowed. Special characters such as (“umlauts”, …) are not permitted and may have to be replaced by ASCII characters (e.g. ü → ue, é → e, …).
UserDataans..1024OIf specified at request, the 1cs Online Payment System forwards the parameter with the payment result to the shop
MACan64MHash Message Authentication Code (HMAC) with SHA-256 algorithm. Details can be found here: HMAC Authentication (Request) HMAC Authentication (Notify)
Plainans..50OA single value that can be set by you to return information unencrypted in the response or notify, e.g. the MID.

“Plain” parameter is part of the encrypted “Data” in the 1cs online payment system and therefore protected against manipulation.
Customans..1024OThe “Custom” parameter is appended to the call before encryption and is part of the encrypted “Data” in the 1cs Online Payment System call. This protects the value against manipulation.

The custom value is then appended to the 1cs Online Payment System response in plain text with “|” replaced by “&”. This allows you to pass a custom value and get back multiple key-value pairs for your own use in the response.

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

2.3 Credit with reference

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

ParameterFormatCNDDescription
MerchantIDans..30MMerchantID, assigned by First Cash Solution. Additionally this parameter has to be passed in plain language too.
PayIDan32MID assigned by the 1cs Online Payment System for the payment to be credited
TransIDans..64MTransactionID provided by you which should be unique for each payment
MACan64MHash Message Authentication Code (HMAC) with SHA-256 algorithm. Details can be found here: HMAC Authentication (Request) HMAC Authentication (Notify)
Amountn..10MAmount in the smallest currency unit (e.g. EUR Cent) Please contact the helpdesk, if you want to capture amounts < 100 (smallest currency unit).
Currencya..3MCurrency code, three digits DIN / ISO 4217, e.g. EUR, USD, GBP. Please find an overview here: A1 Currency table EN
OrderDescans..768OCDescription of refunded goods, unit prices, merchant’s comment etc.
ReqIDans..32OTo avoid duplicate payments, pass an alphanumeric value that identifies your transaction or action and may only be assigned once. If the transaction or action is resubmitted with the same ReqID, the 1cs Online Payment System will not execute a payment or further action but will only return the status of the original transaction or action. Please note that the 1cs Online Payment System must have a completed transaction status for the first initial action. Submissions with identical ReqID on 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 of giropay payments

The following table describes the result parameters that the 1cs online payment system returns as a response:

hinweisbe prepared to receive additional parameters at any time and do not check the order of parameters

hinweisthe parameters (e.g. MerchantId, RefNr) should not be checked case-sentive

ParameterFormatCNDDescription
MIDans..30CMerchantID, assigned by First Cash Solution
PayIDan32MID assigned by the 1cs Online Payment System for the payment, e.g. for referencing in batch files as well as for capture or credit request.
XIDan32MID for all single transactions (authorisation, capture, credit note) for one payment assigned by the 1cs Online Payment System
TransIDans..64MTransactionID provided by you which should be unique for each payment
Statusa..30MOK or FAILED and only in the case of PPRO AUTHORIZE_REQUEST
Descriptionans..1024MFurther details in the event that payment is rejected. Please do not use the Description but the Code parameter for the transaction status analysis!
Coden8MError code according to the 1cs Online Payment System Response Codes Excel file
RefNrans..30OCMerchant’s unique reference number Only ASCII characters are allowed. Special characters such as (“umlauts”, …) are not permitted and may have to be replaced by ASCII characters (e.g. ü → ue, é → e, …).

Result parameters for credits of giropay payments