About Barzahlen

General information about Barzahlen

This manual describes configuring and using the  interface for Barzahlen:

Barzahlen is aimed at customers in Germany who do not want to enter sensitive data online, and those who do not use credit cards or online banking. An alternative to cash on delivery, Barzahlen is quicker and less expensive. Customers pay the amount to an associated retailer, on the basis of a payment form; the retailer transmits a payment confirmation in real time to the online shop so that the goods can be dispatched quickly.

Barzahlen is a payment provider for cash transactions. Customers use cash to pay for online purchases, travel bookings or diverse invoices. It is also possible to pay by cash to one’s own giro account.

The customer receives a barcode via email, SMS or Post to process the payment. This barcode is then scanned at the checkout of an individual partner branch and the customer pays with cash or another permitted payment method. The supplier is notified about payment in real time by the checkout system once the customer has paid. The payment service is carried out by Greensill Bank AG from Bremen.

Currently cash payments are made throughout Germany in over 10,000 branches of the REWE markets, dm-drogerie markets, PENNY markets, real,- supermarkets, Telekom Shops, mobilcom-debitel branches and with Budni chemists and in branches of the Dr. Eckert group.

Cash payments offer users who prefer cash, the option to buy, gamble or to book travel online without entering sensitive financial data. This cash option, means it is the only payment system available to every German without restriction. 68% of Germans over 18 years have no credit card (Deutsche Bundesbank 2015) and 51% do not use online banking (Bundesverband deutscher Banken 2014).


Logo

Info

With Barzahlen online purchases in Germany at over 10,000 branches of retail partners such as real,- can be paid for in cash. The additional customer potential encompasses amongst other things those Internet users who do not yet purchase online.

TypePayments by Cash-In / Bill

 

Further information can be found on the webpage of Barzahlen (https://www.barzahlen.de/de/).


Process flow chart


Barzahlen process flow


Configuration for Barzahlen

Merchants need to initially setup an account with Barzahlen on their webpage: https://controlcenter.barzahlen.de/#/account/signin

You start configuration once you have logged on.

In the cash payment Control Center you need to enter the following URLs under Settings / Divisions (https://controlcenter.barzahlen.de/#/settings/divisions).

Notification URL: BarzahlenComplete.aspx

Sandbox notification URL: BarzahlenComplete.aspx

 

You must send the division-ID together with the payment key to the  Support at , in order to activate this payment method within your MID on .


interface


Call of interface for Barzahlen

To carry out a Barzahlen payment via a Server-to-Server connection, please use the following URL:

barzahlen.aspx


Key

Format

CND

Description

Beschreibung

OrderDesc

ans..512

M

Description of purchased goods, unit prices etc. The first 50 characters appear in the merchant’s settlement file. You can view the full data in the list within .

Beschreibung der gekauften Waren, Einzelpreise etc. Die ersten 50 Zeichen erscheinen erscheinen auf dem Settlement File des Händlers. In der Liste in können Sie die kompletten Daten einsehen.

Key

Format

CND

Description

Beschreibung

CustomerID

ans..80

C

Customer ID or customer number.

If this value is not transmitted, the email address must be transmitted.

Kunden-ID oder Kundennummer.

Wird kein Wert übergeben, muss die E-Mail-Adresse übergeben werden.

Emailans..80C

Email address of the customer.

If this value is not transmitted, the CustomerID must be transmitted.

E-Mail-Adresse des Kunden.

Wird kein Wert übergeben, muss die CustomerID übergeben werden.

Streetans..60OCustomer's street and street number to find the nearest points of acceptanceStraße und Hausnummer des Kunden zur Ermittlung der nächstgelegenen Annahmestellen
ZIPans..10OCustomer's post code to find the nearest points of acceptancePostleitzahl des Kunden zur Ermittlung der nächstgelegenen Annahmestellen
Cityans..50OCustomer's city/town to find the nearest points of acceptanceWohnort des Kunden zur Ermittlung der nächstgelegenen Annahmestellen
CountryCodea2OCountry code according to ISO 3166. The default is DE.Ländercode zweistellig gemäß ISO 3166. Standard ist DE.
Languagea5O5-digit language code which impacts the language of the payment form and the response parameters. The default is de-DE.5-stelliger Sprachcode, beeinflusst die Sprache des Zahl-scheins und der Antwort-Parameter, Standard ist de-DE.
Expirationn..4OValidity of payment form in days. The default validity period of the payment form can also be provided within the Barzahlen backend.Gültigkeit des Zahlscheins in Tagen. Die Standard-Gültigkeit eines Zahlscheins kann auch im Barzahlen-BackEnd hinterlegt werden.
MobileNoans..50O

Customer's mobile phone number with country code.

e.g. +49151123456789

Mobiltelefonnummer des Kunden mit Landesvorwahl.

z.B. +49151123456789

Parameters for payments with Barzahlen


Key

Format

CND

Description

Beschreibung

Statusa..50MAUTHORIZE_REQUEST or FAILEDAUTHORIZE_REQUEST oder FAILED

Key

Format

CND

Description

Beschreibung

CodeExt

n..10

O

Detailed error code from Barzahlen.

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

Detaillierter Fehlercode von Barzahlen.

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

ErrorTextans..256O

Detailed error message from Barzahlen.

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

Detaillierte Fehlermeldung von Barzahlen.

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

Key

Format

CND

Description

Beschreibung

TokenExt

ans..255

M

Token to display the Barzahlen checkout page

Token um die Checkout-Seite von Barzahlen anzuzeigen

TransactionID

ans..50

M

ID for identification of payment formID zur Identifizierung des Zahlscheins

ExpirationNotice

dttm

M

Expiration date of the payment form

Ablaufdatum des Zahlscheins

Response parameters for payments with Barzahlen


The following table gives the results parameters which the  transfers to your URLNotify:

Key

Format

CND

Description

Beschreibung

CodeExt

n..10

O

Detailed error code from Barzahlen.

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

Detaillierter Fehlercode von Barzahlen.

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

ErrorTextans..256O

Detailed error message from Barzahlen.

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

Detaillierte Fehlermeldung von Barzahlen.

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

Key

Format

CND

Description

Beschreibung

TransactionID

ans..50

M

ID for identification of payment formID zur Identifizierung des Zahlscheins

ExpirationNotice

dttm

M

Expiration date of the payment form

Ablaufdatum des Zahlscheins

Response parameters for URLNotify with Barzahlen


The merchant has to implement the following code on his page in order to display the Barzahlen checkout page.

<!-- Barzahlen Checkout -->
<script src=https://cdn.barzahlen.de/js/v2/checkout.js
        class="bz-checkout"
        data-token="CHECKOUT_TOKEN">
</script>
<!-- End Barzahlen Checkout -->


The value of the Checkout_Token is transferred by  in the TokenExt parameter.

The src value must contain the following values for test and productive transactions:

Test: https://cdn.barzahlen.de/js/v2/checkout-sandbox.js\
Productive: https://cdn.barzahlen.de/js/v2/checkout.js



Updating a payment

To update a Barzahlen payment via a Server-to-Server connection, please use the following URL:

barzahlenUpdate.aspx


Key

Format

CND

Description

Beschreibung




Resending a payment formErneutes Sendes des Zahlscheins

EventToken

a1

M

R = Resend

R = Resend

DistributionTypeans..5O

Delivery method of payment form for resending.

Possible values: Email, Phone; default is Email.

When resending a payment form for credits always an email is sent to the customer.

Auslieferungsart des Zahlscheins beim erneuten Senden.

Mögliche Werte: Email, Phone; Standard ist Email.

Beim erneuten Senden eines Zahlscheins für Gutschriften wird immer eine E-Mail an den Kunden gesendet.




Updating a payment formAktualisieren eines Zahlscheins
EventTokena1MU = UpdateU = Update
Amountn..10OC

Amount in the smallest currency unit (e.g. EUR Cent). Not for credits.

Betrag in der kleinsten Währungseinheit (z.B. EUR Cent). Nicht bei Gutschriften.

MobileNoans..50OCCustomer’s new mobile telephone number. Not for credits.Neue Mobiltelefonnummer des Kunden. Nicht bei Gutschriften.
Emailans..255OCNew email address of the customer. Not for creditsNeue E-Mail-Adresse des Kunden. Nicht bei Gutschriften.
Expirationn..4O

New validity of payment form in days.

Updating the validity of a payment form.

Neue Gültigkeit des Zahlscheins in Tagen.

Aktualisierung der Gültigkeit eines Zahlscheins.

Parameters for updating a payment with Barzahlen


Key

Format

CND

Description

Beschreibung

CodeExt

ans..10

O

Detailed error code from Barzahlen.

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

Detaillierter Fehlercode von Barzahlen.

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

ErrorTextans..1024O

Detailed error message from Barzahlen.

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

Detaillierte Fehlermeldung von Barzahlen.

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

TransactionIDans..50MID for identification of payment formID zur Identifizierung des Zahlscheins
ExpirationNoticedttmMExpiration date of the payment formAblaufdatum des Zahlscheins

Response parameters for updating of Barzahlen



Credit with reference

Credits (refunds) are possible via a Server-to-Server connection. To carry out a credit with a reference transaction, please use the following URL:

credit.aspx


Key

Format

CND

Description

Beschreibung

OrderDesc

ans..768

O

Description of refunded goods, unit prices, merchant’s comment etc.

Beschreibung der gutgeschriebenen Artikel, Einzelpreise, Händlerkommentar etc.

Parameters for credits of Barzahlen payments


Result parameters for credits of Barzahlen payments



Reversal

In order to cancel a Barzahlen payment via a server-to-server communication, please go to the following URL:

reverse.aspx


Notice: Reverse.aspx does not only reverse authorisations, but any LAST TRANSACTION STAGE! If the last transaction was a capture, Reverse.aspx initiates the reverse, e.g. a credit. Therefore, the utmost caution is urged. Use is at your own risk. We recommend checking the transaction status with Inquire.aspx before using Reverse.aspx.

Parameters for reversals of Barzahlen payments


Result parameters for reversals of Barzahlen payments



Batch processing via the interface

This section describes the parameters which must be transferred within the data set (Record) for executing reversals or credits with Barzahlen and which information can be found within the response file about the payment status.

For Batch calls there must be considered batch versions, from which optional parameters depend. All version designations starting with „2.“ pertain calls for a group of enterprises. That means within a batch file for a particular MerchantID can be transferred transactions for other merchants with a separate Sub-MID.

Following table gives an overview of all batch versions that are possible for a specific action and 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)
Reverse

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

HEAD,<MerchantID>,<Date>,<Version>
Barzahlen,Credit,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID>
Barzahlen,Reverse,<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, Barzahlen for Barzahlen

HEAD für Header, FOOT für Footer, Barzahlen für Barzahlen

Action

a..20

M

The parameter Action defines the type of transaction:

Credit

Reverse (cancellation)

Der Action-Parameter definiert die Art der Transaktion:

Credit (Gutschrift)
Reverse (Storno)

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>
Barzahlen,Credit,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID>,<Status>,<Code>
Barzahlen,Reverse,<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

Reverse (cancellation)

Der Action-Parameter definiert die Art der Transaktion:

Credit (Gutschrift)

Reverse (Storno)

Description of result parameters within the record for Batch files