Maintenance Work Notice!

We will carry out maintenance work on this documentation on Tuesday, 15.06.2021 between 3 pm and 4 pm CEST. Thank you for your understanding.

Page tree

Search

Skip to end of metadata
Go to start of metadata


Integration Guide

Version 6.9

Stand 01.09.2019


Inhaltsverzeichnis


Dokumenthistorie

Datum

Name

Änderung

01.09.2019

Peter Posse

Erstfassung Confluence

 


Über Bank Transfer

Allgemeines zu Bank Transfer





Diagramm zum Prozessablauf

Bank Transfer Prozessablauf


Paygate-Schnittstelle

    Page not found for multiexcerpt macro.
The page: DOCCT:Definition DE was not found. Please check/update the page name used in the 'multiexcerpt-include' macro.


Bank-Transfer-Zahlung via Formular-Schnittstelle

Um eine Zahlung mit Online-Überweisung von Bank Transfer abzuwickeln, rufen Sie folgende URL auf:


Hinweis: Aus Sicherheitsgründen lehnt das Paygate alle Zahlungsanfragen mit Formatfehlern ab. Bitte übergeben Sie deshalb bei jedem Parameter den korrekten Datentyp.

Die folgende Tabelle beschreibt die verschlüsselten Übergabeparameter:

Parameter

Format

CND

Beschreibung

MerchantID

ans..30

M

HändlerID, die von Computop vergeben wird. Dieser Parameter ist zusätzlich auch unverschlüsselt zu übergeben.

TransID

ans..64

M

Transaktionsnummer des Händlers, die eindeutig sein muss

RefNr

ans..40

O

Eindeutige Referenznummer. Nur die Zeichen a-zA-Z0-9,-_ sind erlaubt.

Amount

n..10

M

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

Bitte wenden Sie sich an den Helpdesk, wenn Sie Beträge < 100 (kleinste Währungseinheit) buchen möchten.

Currency

a3

M

Währung, drei Zeichen DIN / ISO 4217

MAC

an64

M

Hash Message Authentication Code (HMAC) mit SHA-256-Algorithmus

URLSuccess

ans..256

M

Vollständige URL, die das Paygate aufruft, wenn die Zahlung erfolgreich war. Die URL darf nur über Port 443 aufgerufen werden. Diese URL darf keine Parameter enthalten: Um Parameter durchzureichen nutzen Sie stattdessen den Parameter UserData.

URLFailure

ans..256

M

Vollständige URL, die das Paygate aufruft, wenn die Zahlung gescheitert ist. Die URL darf nur über Port 443 aufgerufen werden. Diese URL darf keine Parameter enthalten: Um Parameter durchzureichen nutzen Sie stattdessen den Parameter UserData.

Response

a7

O

Die Status-Rückmeldung, die das Paygate an URLSuccess und URLFailure sendet, sollte verschlüsselt werden. Dazu übergeben Sie den Parameter Response=encrypt.

URLNotify

ans..256

M

Vollständige URL, die das Paygate aufruft, um den Shop zu benachrichtigen. Die URL darf nur über Port 443 aufgerufen werden. Sie darf keine Parameter enthalten: Nutzen Sie stattdessen den Parameter UserData.

UserData

ans..1024

O

Wenn beim Aufruf angegeben, übergibt das Paygate die Parameter mit dem Zahlungsergebnis an den Shop

ReqID

ans..32

O

Um Doppelzahlungen zu vermeiden, übergeben Sie einen alphanumerischen Wert, der Ihre Transaktion identifiziert und nur einmal vergeben werden darf. Falls die Transaktion mit derselben ReqID erneut eingereicht wird, führt das Paygate keine Zahlung aus sondern gibt nur den Status der ursprünglichen Transaktion zurück. Bitte beachten Sie, dass das Paygate für die erste initiale Aktion einen abgeschlossenen Transaktionsstatus haben muss. Einreichungen mit identischer ReqID auf einen offenen Status werden regulär verarbeitet.

OrderDesc

ans..768

M

Beschreibung der Waren, Einzelpreise usw., Verwendungszweck auf dem Kontoauszug

SellingPoint

ans..50

O

Verkaufsstelle

Service

ans..50

O

verkaufte Produkte oder Dienstleistung

Channel

ans..64

O

Konfigurationskanal des PPRO-Vertrags (Account und ContractID sind im System hinterlegt). Wenn vorhanden, überschreibt er eventuell im System hinterlegten Channel.

Languagea2O2-stelliger Sprachcode (z.B. de), der für die Zahlungsseiten für den Kunden bevorzugt werden soll

AccOwner

ans..50

M

Name des Kontoinhabers

Email

ans..100

M

E-Mail-Adresse des Kontoinhabers

Plain

ans..50

O

Ein von Händler zu setzender Wert, um Informationen wieder unverschlüsselt zurückzugeben, z.B. die MID

Custom

ans..1024

O

Der Händler kann mehrere Werte durch | getrennt übergeben, die unverschlüsselt durch & getrennt zurückgegeben werden.

Custom=session=123|id=456 wird in der Antwort zu Session=123&id=456

Parameter für Zahlungen mit Bank Transfer


Die folgende Tabelle beschreibt die Ergebnis-Parameter, die das Paygate an Ihre URLSuccess, URLFailure oder URLNotify übergibt. Wenn Sie den Parameter Response=encrypt angegeben haben, werden die folgenden Parameter mit Blowfish verschlüsselt an Ihr System übergeben:

Parameter

Format

CND

Beschreibung

MID

ans..30

M

HändlerID, die von Computop vergeben wird

PayID

an32

M

Vom Paygate vergebene ID für die Zahlung, z.B. zur Referenzierung in Batch-Dateien

XID

an32

M

Vom Paygate vergebene ID für alle einzelnen Transaktionen (Autorisierung, Buchung, Gutschrift), die für eine Zahlung durchgeführt werden

TransID

ans..64

M

Transaktionsnummer des Händlers

RefNr

ans..40

O

Referenznummer des Händlers. Nur die Zeichen a-zA-Z0-9,-_ sind erlaubt.

Status

a..30

M

OK bei URLSuccess und AUTHORIZE_REQUEST oder FAILED bei URLFailure

Description

ans..1024

M

Nähere Beschreibung bei Ablehnung der Zahlung. Bitte nutzen Sie nicht den Parameter Description sondern Code für die Auswertung des Transaktionsstatus!

Code

n8

M

Fehlercode gemäß Excel-Datei Paygate Antwort Codes (Teil des Software Clients auf https://www.computop.com/de/downloads/)

MAC

an64

M

Hash Message Authentication Code (HMAC) mit SHA-256-Algorithmus

UserData

ans..1024

O

Wenn beim Aufruf angegeben, übergibt das Paygate die Parameter mit dem Zahlungsergebnis an den Shop

PaymentPurpose

ans..26

M

Zahlungszweck

PaymentGuarantee

a..12

C

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

C

Detaillierte PPRO Fehlermeldung.

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

TransactionID

an..20

O

Eindeutige Transaktionsnummer bei PPRO

Plain

ans..50

O

Ein von Händler zu setzender Wert, um Informationen wieder unverschlüsselt zurückzugeben, z.B. die MID

Custom

ans..1024

O

Der Händler kann mehrere Werte durch | getrennt übergeben, die unverschlüsselt durch & getrennt zurückgegeben werden.

Custom=session=123|id=456 wird in der Antwort zu Session=123&id=456

Ergebnis-Parameter für URLSuccess, URLFailure und URLNotify bei Bank Transfer




Gutschrift mit Referenz

Gutschriften sind über eine Server-zu-Server-Kommunikation möglich. Bei einer Gutschrift mit Bezug auf eine Buchung ist die Höhe der Gutschrift auf die Höhe der vorangegangen Buchung beschränkt.

Um eine Gutschrift (Credit) mit Referenztransaktion auszuführen, verwenden Sie bitte folgende URL:


Die folgenden Tabellen beschreiben die Übergabeparameter und Rückgabewerte, die über die Socket-Verbindung ausgetauscht werden.

Hinweis: Aus Sicherheitsgründen lehnt das Paygate alle Zahlungsanfragen mit Formatfehlern ab. Bitte übergeben Sie deshalb bei jedem Parameter den korrekten Datentyp.

Die folgende Tabelle beschreibt die verschlüsselten Übergabeparameter:

Parameter

Format

CND

Beschreibung

MerchantID

ans..30

M

HändlerID, die von Computop vergeben wird. Dieser Parameter ist zusätzlich auch unverschlüsselt zu übergeben.

PayID

an32

M

Vom Paygate vergebene ID für die gutzuschreibende Transaktion

TransID

ans..64

M

TransaktionsID, die für jede Zahlung eindeutig sein muss

Amount

n..10

M

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

Bitte wenden Sie sich an den Helpdesk, wenn Sie Beträge < 100 (kleinste Währungseinheit) buchen möchten.

Currency

a..3

M

Währungskürzel, drei Zeichen DIN / ISO 4217

MAC

an64

M

Hash Message Authentication Code (HMAC) mit SHA-256-Algorithmus

ReqIDans..32OUm Doppelzahlungen zu vermeiden, übergeben Sie einen alphanumerischen Wert, der Ihre Transaktion identifiziert und nur einmal vergeben werden darf. Falls die Transaktion mit derselben ReqID erneut eingereicht wird, führt das Paygate keine Zahlung aus sondern gibt nur den Status der ursprünglichen Transaktion zurück. Bitte beachten Sie, dass das Paygate für die erste initiale Aktion einen abgeschlossenen Transaktionsstatus haben muss. Einreichungen mit identischer ReqID auf einen offenen Status werden regulär verarbeitet.

Parameter für Gutschrift von Zahlungen mit Bank Transfer über Socket-Verbindungen


Die folgende Tabelle beschreibt die Ergebnis-Parameter, die das Paygate als Antwort zurückgibt:

Parameter

Format

CND

Beschreibung

MID

ans..30

M

HändlerID, die von Computop vergeben wird

PayID

an32

M

Vom Paygate vergebene ID für die Zahlung, z.B. zur Referenzierung in Batch-Dateien

XID

an32

M

Vom Paygate vergebene ID für alle einzelnen Transaktionen (Autorisierung, Buchung, Gutschrift), die für eine Zahlung durchgeführt werden

TransID

ans..64

M

Transaktionsnummer des Händlers

Status

a..30

M

OK oder FAILED

Description

ans..1024

M

Nähere Beschreibung bei Ablehnung der Zahlung. Bitte nutzen Sie nicht den Parameter Description sondern Code für die Auswertung des Transaktionsstatus!

Code

n8

M

Fehlercode gemäß Excel-Datei Paygate Antwort Codes (Teil des Software Clients auf https://www.computop.com/de/downloads/)

RefNr

ans..40

O

Referenznummer des Händlers. Nur die Zeichen a-zA-Z0-9,-_ sind erlaubt.

ErrorText

ans..256

O

detaillierte PPRO Fehlermeldung

TransactionID

an..20

O

Eindeutige Transaktionsnummer bei PPRO

Antwort-Parameter für Gutschrift von Zahlungen mit Bank Transfer über Socket-Verbindungen



Batch-Nutzung der Schnittstelle

Grundsätzliche Informationen zur Arbeit mit Batch-Dateien sowie zu deren Aufbau erfahren Sie im separaten Handbuch zum Batchmanager. Im Batch-Verfahren sind nicht alle Funktionen verfügbar, die für die Online-Schnittstelle verfügbar sind.

Dieses Kapitel beschreibt die Parameter, die Sie im Datensatz (Record) für die Ausführung von Gutschriften mit Bank Transfer übergeben müssen und welche Informationen Sie der Antwort-Datei über den Status des Zahlungsvorgangs entnehmen können.

Folgende Tabelle gibt eine Übersicht der pro Aktion jeweils möglichen Batch-Versionen und ihrer Besonderheiten:

Aktion

Version

Beschreibung

Credit

1.0 / 2.0

Standardversion ohne Rückgabe von Code

 

1.x / 2.x

mit RefNr (gilt für alle Versionen außer 1.0)

Beschreibung der möglichen Batch-Versionen


Der Aufbau für eine Zahlung mit Bank Transfer in einer einzureichenden Batch-Datei sieht folgendermaßen aus:

HEAD,<MerchantID>,<Date>,<Version>

Bank Transfer,Credit,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID>

FOOT,<CountRecords>,<SumAmount>


Die folgende Tabelle beschreibt die einzelnen Felder und Werte, die im Datensatz (Record) innerhalb der Batch-Datei verwendet werden:

Parameter

Format

CND

Beschreibung

Type

a..11

M

HEAD für Header, FOOT für Footer, Bank Transfer für Bank Transfer

Action

a..20

M

Der Action-Parameter definiert die Art der Transaktion:

Credit (Gutschrift)

Amount

n..10

M

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

Bitte wenden Sie sich an den Helpdesk, wenn Sie Beträge < 100 (kleinste Währungseinheit) buchen möchten.

Currency

a3

M

Währungskürzel, drei Zeichen DIN / ISO 4217

TransID

ans..64

M

TransaktionsID, die für jede Zahlung eindeutig sein muss

RefNr

ans..40

O

Eindeutige Referenznummer. Nur die Zeichen a-zA-Z0-9,-_ sind erlaubt.

PayID

an32

M

Vom Paygate vergebene ID für diese Transaktion

Beschreibung der Felder im Datensatz von Batch-Dateien


Der Record-Bereich in der Antwort-Datei zu Batch-Transaktionen sieht folgendermaßen aus:

HEAD,<MerchantID>,<Date>,<Version>

Bank Transfer,Credit,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID>,<Status>,<Code>

FOOT,<CountRecords>,<SumAmount>


Beispiel für Master MID Funktion:

HEAD,[Master]MerchantID,Date,2.x
Type,Action,[Slave]MID,Amount,Currency,TransID,Data (depends on Action)
FOOT,CountRecords,SumAmount


Die folgende Tabelle beschreibt die Antwort-Parameter, die der Batch-Manager im Record-Bereich zu jeder Transaktion speichert (hier nicht erklärte Standardparameter wie etwa <TransID> oder <RefNR> und Aufrufparameter, werden unverändert zum Aufruf wieder zurückgegeben und sind vorstehend beschrieben):

Parameter

Format

CND

Beschreibung

Action

a..20

M

Der Action-Parameter definiert die Art der Transaktion:

Credit (Gutschrift)

PayID

an32

M

Vom Paygate vergebene ID für diese Transaktion

Status

a..50

M

OK oder FAILED

Code

n8

M

Fehlercode gemäß Excel-Datei Paygate Antwort Codes (Teil des Software Clients auf https://www.computop.com/de/downloads/).

Beschreibung der Ergebnis-Parameter im Datensatz von Batch-Dateien

  • No labels