Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Published by Scroll Versions from space ENWORK and version Documentation
Table of Contents


About Barzahlen

General information about Barzahlen

This manual describes configuring and using the 

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNamePartner-Name
PageWithExcerptWording
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).


Page properties
Logo

Info
Excerpt

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

Image Removed
Multiexcerpt
MultiExcerptNameProcessFlow

draw.io Diagram
bordertrue
diagramNameBarzahlen_CT
simpleViewerfalse
linksauto
tbstyletop
lboxtrue
diagramWidth1387

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:

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameBaseURL
PageWithExcerptWording
BarzahlenComplete.aspx

Sandbox notification URL:

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameBaseURL
PageWithExcerptWording
BarzahlenComplete.aspx

 

You must send the division-ID together with the payment key to the 

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNamePartner-Name
PageWithExcerptWording
Support at
Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameHelpdesk-Name
PageWithExcerptWording
, in order to activate this payment method within your MID on
Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNamePlatform-Kurz
PageWithExcerptWording
.


Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNamePlatform-Kurz
PageWithExcerptWording
interface

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameDefinition
PageWithExcerptDefinition EN


Call of interface for Barzahlen

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

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameBaseURL
PageWithExcerptWording
barzahlen.aspx


Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameRequest_Intro
PageWithExcerptReuse API

Table Filter
defaultBeschreibung
isFirstTimeEnterfalse
hideColumnstrue
sparkNameSparkline
hidePanetrue
datepatterndd M yy
id1643792542215_119559542
worklog365|5|8|y w d h m|y w d h m
isORAND
separatorPoint (.)
order0
Multiexcerpt
MultiExcerptNamebarzahlen_request
Table Transformer
dateFormatdd M yy
export-wordfalse
show-sourcefalse
export-csvfalse
id1643792542218_-1104206454
transposefalse
worklog365|5|8|y w d h m|y w d h m
separator.
export-pdffalse
sqlSELECT * FROM T*

Table Excerpt Include
statictrue
nameMerchantID
pageMerchantID
typepage

Table Excerpt Include
statictrue
nameTransID
pageTransID
typepage

Key

Format

CND

Description

Beschreibung

RefNr

ns..30

O

Unique reference number

Eindeutige Referenznummer

Table Excerpt Include
statictrue
nameAmount
pageAmount
typepage

Table Excerpt Include
statictrue
nameCurrency
pageCurrency
typepage

Table Excerpt Include
statictrue
nameMAC
pageMAC
typepage

Table Excerpt Include
statictrue
nameURLNotify
pageURLNotify
typepage

Table Excerpt Include
statictrue
nameUserData
pageUserData
typepage

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

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameBackoffice-Name
PageWithExcerptWording
.

Beschreibung der gekauften Waren, Einzelpreise etc. Die ersten 50 Zeichen erscheinen erscheinen auf dem Settlement File des Händlers. In der Liste in

Multiexcerpt include
SpaceWithExcerptDE
MultiExcerptNameBackoffice-Name
PageWithExcerptDE:Wording
können Sie die kompletten Daten einsehen.

Table Excerpt Include
statictrue
nameReqId-ans..32
pageReqId
typepage

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

Table Excerpt Include
statictrue
namePlain
pagePlain
typepage

Table Excerpt Include
statictrue
nameCustom
pageCustom
typepage

Parameters for payments with Barzahlen


Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameResponse_Intro
PageWithExcerptReuse API

Table Filter
defaultBeschreibung
isFirstTimeEnterfalse
hideColumnstrue
sparkNameSparkline
hidePanetrue
datepatterndd M yy
id1643793888808_-910105299
worklog365|5|8|y w d h m|y w d h m
isORAND
separatorPoint (.)
order0
Multiexcerpt
MultiExcerptNamebarzahlen_response
Table Transformer
dateFormatdd M yy
export-wordfalse
show-sourcefalse
export-csvfalse
id1643793888810_-519776912
transposefalse
worklog365|5|8|y w d h m|y w d h m
separator.
export-pdffalse
sqlSELECT * FROM T*

Table Excerpt Include
statictrue
nameMID
pagemid
typepage

Table Excerpt Include
statictrue
namePayID
pagePayID
typepage

Table Excerpt Include
statictrue
nameXID
pageXID
typepage

Table Excerpt Include
statictrue
nameTransID
pageTransID
typepage

Key

Format

CND

Description

Beschreibung

RefNr

ns..30

O

Unique reference number

Eindeutige Referenznummer

Statusa..50MAUTHORIZE_REQUEST or FAILEDAUTHORIZE_REQUEST oder FAILED

Table Excerpt Include
statictrue
nameDescription
pageDescription
typepage

Table Excerpt Include
statictrue
nameCode
pageCode
typepage

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

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameHelpdesk-Name
PageWithExcerptWording
.

Detaillierter Fehlercode von Barzahlen.

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

Multiexcerpt include
SpaceWithExcerptDE
MultiExcerptNameHelpdesk-Name
PageWithExcerptDE:Wording
möglich.

ErrorTextans..256O

Detailed error message from Barzahlen.

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

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameHelpdesk-Name
PageWithExcerptWording
.

Detaillierte Fehlermeldung von Barzahlen.

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

Multiexcerpt include
SpaceWithExcerptDE
MultiExcerptNameHelpdesk-Name
PageWithExcerptDE:Wording
möglich.

Table Excerpt Include
statictrue
nameUserData
pageUserData
typepage

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

Table Excerpt Include
statictrue
namePlain
pagePlain
typepage

Table Excerpt Include
statictrue
nameCustom
pageCustom
typepage

Response parameters for payments with Barzahlen


The following table gives the results parameters which the 

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNamePlatform-Kurz
PageWithExcerptWording
transfers to your URLNotify:

Table Filter
defaultBeschreibung
isFirstTimeEnterfalse
hideColumnstrue
sparkNameSparkline
hidePanetrue
datepatterndd M yy
id1643797147847_-1170348435
worklog365|5|8|y w d h m|y w d h m
isORAND
separatorPoint (.)
order0
Multiexcerpt
MultiExcerptNamebarzahlen_notify
Table Transformer
dateFormatdd M yy
export-wordfalse
show-sourcefalse
export-csvfalse
id1643797147849_219853260
transposefalse
worklog365|5|8|y w d h m|y w d h m
separator.
export-pdffalse
sqlSELECT * FROM T*

Table Excerpt Include
statictrue
nameMID
pagemid
typepage

Table Excerpt Include
statictrue
namePayID
pagePayID
typepage

Table Excerpt Include
statictrue
nameXID
pageXID
typepage

Table Excerpt Include
statictrue
nameTransID
pageTransID
typepage

Key

Format

CND

Description

Beschreibung

RefNr

ns..30

O

Unique reference number

Eindeutige Referenznummer

Table Excerpt Include
statictrue
nameStatus_OK_FAILED
pageStatus
typepage

Table Excerpt Include
statictrue
nameDescription
pageDescription
typepage

Table Excerpt Include
statictrue
nameCode
pageCode
typepage

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

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameHelpdesk-Name
PageWithExcerptWording
.

Detaillierter Fehlercode von Barzahlen.

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

Multiexcerpt include
SpaceWithExcerptDE
MultiExcerptNameHelpdesk-Name
PageWithExcerptDE:Wording
möglich.

ErrorTextans..256O

Detailed error message from Barzahlen.

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

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameHelpdesk-Name
PageWithExcerptWording
.

Detaillierte Fehlermeldung von Barzahlen.

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

Multiexcerpt include
SpaceWithExcerptDE
MultiExcerptNameHelpdesk-Name
PageWithExcerptDE:Wording
möglich.

Table Excerpt Include
statictrue
nameUserData
pageUserData
typepage

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

Table Excerpt Include
statictrue
namePlain
pagePlain
typepage

Table Excerpt Include
statictrue
nameCustom
pageCustom
typepage

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.

Multiexcerpt
MultiExcerptNamebarzahlenhbarzahlen_checkout
shouldDisplayInlineCommentsInIncludesfalse
Code Block
languagexml
<!-- 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 

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNamePartner-Name
PageWithExcerptWording
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, call the following URL:

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameBaseURL
PageWithExcerptWording
barzahlenUpdate.aspx


Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameRequest_Intro
PageWithExcerptReuse API

Table Filter
defaultBeschreibung
isFirstTimeEnterfalse
hideColumnstrue
sparkNameSparkline
hidePanetrue
datepatterndd M yy
id1643798469091_1984013041
worklog365|5|8|y w d h m|y w d h m
isORAND
separatorPoint (.)
order0
Multiexcerpt
MultiExcerptNamebarzahlen_update_request
Table Transformer
dateFormatdd M yy
export-wordfalse
show-sourcefalse
export-csvfalse
id1643798469093_459204909
transposefalse
worklog365|5|8|y w d h m|y w d h m
separator.
export-pdffalse
sqlSELECT * FROM T*

Table Excerpt Include
statictrue
nameMerchantID
pageMerchantID
typepage

Table Excerpt Include
statictrue
namePayID
pagePayID
typepage

Table Excerpt Include
statictrue
nameMAC
pageMAC
typepage

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


Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameResponse_Intro
PageWithExcerptReuse API

Table Filter
defaultBeschreibung
isFirstTimeEnterfalse
hideColumnstrue
sparkNameSparkline
hidePanetrue
datepatterndd M yy
id1643811424300_355999906
worklog365|5|8|y w d h m|y w d h m
isORAND
separatorPoint (.)
order0
Multiexcerpt
MultiExcerptNamebarzahlen_update_response
Table Transformer
dateFormatdd M yy
export-wordfalse
show-sourcefalse
export-csvfalse
id1643811424302_-982581628
transposefalse
worklog365|5|8|y w d h m|y w d h m
separator.
export-pdffalse
sqlSELECT * FROM T*

Table Excerpt Include
statictrue
nameMID
pagemid
typepage

Table Excerpt Include
statictrue
namePayID
pagePayID
typepage

Table Excerpt Include
statictrue
nameXID
pageXID
typepage

Table Excerpt Include
statictrue
nameTransID
pageTransID
typepage

Table Excerpt Include
statictrue
nameStatus_OK_FAILED
pageStatus
typepage

Table Excerpt Include
statictrue
nameDescription
pageDescription
typepage

Table Excerpt Include
statictrue
nameCode
pageCode
typepage

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

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameHelpdesk-Name
PageWithExcerptWording
.

Detaillierter Fehlercode von Barzahlen.

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

Multiexcerpt include
SpaceWithExcerptDE
MultiExcerptNameHelpdesk-Name
PageWithExcerptDE:Wording
möglich.

ErrorTextans..1024O

Detailed error message from Barzahlen.

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

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameHelpdesk-Name
PageWithExcerptWording
.

Detaillierte Fehlermeldung von Barzahlen.

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

Multiexcerpt include
SpaceWithExcerptDE
MultiExcerptNameHelpdesk-Name
PageWithExcerptDE:Wording
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:

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameBaseURL
PageWithExcerptWording
credit.aspx


Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameRequest_Intro
PageWithExcerptReuse API

Table Filter
defaultBeschreibung
isFirstTimeEnterfalse
hideColumnstrue
sparkNameSparkline
hidePanetrue
datepatterndd M yy
id1643814251843_313609340
worklog365|5|8|y w d h m|y w d h m
isORAND
separatorPoint (.)
order0
Multiexcerpt
MultiExcerptNamebarzahlen_credit_request
Table Transformer
dateFormatdd M yy
export-wordfalse
show-sourcefalse
export-csvfalse
id1643814251845_-1134055962
transposefalse
worklog365|5|8|y w d h m|y w d h m
separator.
export-pdffalse
sqlSELECT * FROM T*

Table Excerpt Include
statictrue
nameMerchantID
pageMerchantID
typepage

Table Excerpt Include
statictrue
namePayID
pagePayID
typepage

Table Excerpt Include
statictrue
nameTransID
pageTransID
typepage

Table Excerpt Include
statictrue
nameAmount
pageAmount
typepage

Table Excerpt Include
statictrue
nameCurrency
pageCurrency
typepage

Table Excerpt Include
statictrue
nameMAC
pageMAC
typepage

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.

Table Excerpt Include
statictrue
nameReqId-ans..32
pageReqId
typepage

Parameters for credits of Barzahlen payments


Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameResponse_Intro
PageWithExcerptReuse API

Table Filter
defaultBeschreibung
isFirstTimeEnterfalse
hideColumnstrue
sparkNameSparkline
hidePanetrue
datepatterndd M yy
id1643814556007_-1500610840
worklog365|5|8|y w d h m|y w d h m
isORAND
separatorPoint (.)
order0
Multiexcerpt
MultiExcerptNamebarzahlen_credit_response
Table Transformer
dateFormatdd M yy
export-wordfalse
show-sourcefalse
export-csvfalse
id1643814556008_287102427
transposefalse
worklog365|5|8|y w d h m|y w d h m
separator.
export-pdffalse
sqlSELECT * FROM T*

Table Excerpt Include
statictrue
nameMID
pagemid
typepage

Table Excerpt Include
statictrue
namePayID
pagePayID
typepage

Table Excerpt Include
statictrue
nameXID
pageXID
typepage

Table Excerpt Include
statictrue
nameTransID
pageTransID
typepage

Table Excerpt Include
statictrue
nameStatus_OK_FAILED
pageStatus
typepage

Table Excerpt Include
statictrue
nameDescription
pageDescription
typepage

Table Excerpt Include
statictrue
nameCode
pageCode
typepage

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:

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameBaseURL
PageWithExcerptWording
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.

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameRequest_Intro
PageWithExcerptReuse API

Table Filter
defaultBeschreibung
isFirstTimeEnterfalse
hideColumnstrue
sparkNameSparkline
hidePanetrue
datepatterndd M yy
id1643815717494_-769565915
worklog365|5|8|y w d h m|y w d h m
isORAND
separatorPoint (.)
order0
Multiexcerpt
MultiExcerptNamebarzahlen_reverse_request
Table Transformer
dateFormatdd M yy
export-wordfalse
show-sourcefalse
export-csvfalse
id1643815717495_-984707421
transposefalse
worklog365|5|8|y w d h m|y w d h m
separator.
export-pdffalse
sqlSELECT * FROM T*

Table Excerpt Include
statictrue
nameMerchantID
pageMerchantID
typepage

Table Excerpt Include
statictrue
namePayID
pagePayID
typepage

Table Excerpt Include
statictrue
nameTransID
pageTransID
typepage

Table Excerpt Include
statictrue
nameAmount
pageAmount
typepage

Table Excerpt Include
statictrue
nameCurrency
pageCurrency
typepage

Table Excerpt Include
statictrue
nameMAC
pageMAC
typepage

Table Excerpt Include
statictrue
nameReqId-ans..32
pageReqId
typepage

Parameters for reversals of Barzahlen payments


Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameResponse_Intro
PageWithExcerptReuse API

Table Filter
defaultBeschreibung
isFirstTimeEnterfalse
hideColumnstrue
sparkNameSparkline
hidePanetrue
datepatterndd M yy
id1643815802755_-317172452
worklog365|5|8|y w d h m|y w d h m
isORAND
separatorPoint (.)
order0
Multiexcerpt
MultiExcerptNamebarzahlen_reverse_response
Table Transformer
dateFormatdd M yy
export-wordfalse
show-sourcefalse
export-csvfalse
id1643815802757_-1050547583
transposefalse
worklog365|5|8|y w d h m|y w d h m
separator.
export-pdffalse
sqlSELECT * FROM T*

Table Excerpt Include
statictrue
nameMID
pagemid
typepage

Table Excerpt Include
statictrue
namePayID
pagePayID
typepage

Table Excerpt Include
statictrue
nameXID
pageXID
typepage

Table Excerpt Include
statictrue
nameTransID
pageTransID
typepage

Table Excerpt Include
statictrue
nameStatus_OK_FAILED
pageStatus
typepage

Table Excerpt Include
statictrue
nameDescription
pageDescription
typepage

Table Excerpt Include
statictrue
nameCode
pageCode
typepage

Result parameters for reversals of Barzahlen 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 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:

Table Filter
defaultBeschreibung
isFirstTimeEnterfalse
hideColumnstrue
sparkNameSparkline
hidePanetrue
datepatterndd M yy
id1643838327242_-1190591487
worklog365|5|8|y w d h m|y w d h m
isORAND
separatorPoint (.)
order0
Multiexcerpt
MultiExcerptNamebatch_versions
Table Transformer
dateFormatdd M yy
export-wordfalse
show-sourcefalse
export-csvfalse
id1643838327244_-2113755042
transposefalse
worklog365|5|8|y w d h m|y w d h m
separator.
export-pdffalse
sqlSELECT * FROM T*

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:

Multiexcerpt
MultiExcerptNamebatch_structure
shouldDisplayInlineCommentsInIncludesfalse
Code Block
languagexml
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:

Multiexcerpt
MultiExcerptNamebatch_MasterMid
shouldDisplayInlineCommentsInIncludesfalse
Code Block
languagexml
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:

Table Filter
defaultBeschreibung
isFirstTimeEnterfalse
hideColumnstrue
sparkNameSparkline
hidePanetrue
datepatterndd M yy
id1643838464392_-462150057
worklog365|5|8|y w d h m|y w d h m
isORAND
separatorPoint (.)
order0
Multiexcerpt
MultiExcerptNamebatch_request
Table Transformer
dateFormatdd M yy
export-wordfalse
show-sourcefalse
export-csvfalse
id1643838464394_597308878
transposefalse
worklog365|5|8|y w d h m|y w d h m
separator.
export-pdffalse
sqlSELECT * FROM T*

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)

Table Excerpt Include
nameAmount
pageAmount
typepage

Table Excerpt Include
statictrue
nameCurrency
pageCurrency
typepage

Table Excerpt Include
statictrue
nameTransID
pageTransID
typepage

Key

Format

CND

Description

Beschreibung

RefNr

ns..30

O

Unique reference number

Eindeutige Referenznummer

Table Excerpt Include
statictrue
namePayID_Batch
pagePayID
typepage

Description of fields within the record for Batch files

 

The record area within the response file for Batch transactions looks the following way:

Multiexcerpt
MultiExcerptNamebatch_Response
shouldDisplayInlineCommentsInIncludesfalse
Code Block
languagexml
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>


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):

Table Filter
defaultBeschreibung
isFirstTimeEnterfalse
hideColumnstrue
sparkNameSparkline
hidePanetrue
datepatterndd M yy
id1643838640190_2008448079
worklog365|5|8|y w d h m|y w d h m
isORAND
separatorPoint (.)
order0
Multiexcerpt
MultiExcerptNamebatch_response
Table Transformer
dateFormatdd M yy
export-wordfalse
show-sourcefalse
export-csvfalse
id1643838640192_-1411442441
transposefalse
worklog365|5|8|y w d h m|y w d h m
separator.
export-pdffalse
sqlSELECT * FROM T*

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)

Table Excerpt Include
statictrue
namePayID_Batch
pagePayID
typepage

Table Excerpt Include
statictrue
nameStatus_OK_FAILED
pageStatus
typepage

Table Excerpt Include
statictrue
nameCode
pageCode
typepage

Description of result parameters within the record for Batch files