Page tree

Search

Skip to end of metadata
Go to start of metadata


Über PayMorrow

Allgemeines zu PayMorrow


Logo

Info

PayMorrow unterstützt Rechnungskauf und gesicherte Lastschrift in Deutschland. Händler profitieren von einem umfassenden Schutz vor Zahlungsausfällen.

TypGemischte Zahlarten

Weitere Informationen finden Sie auch auf der Webseite von PayMorrow (https://paymorrow.de/).


Diagramm zum Prozessablauf

PayMorrow Prozessablauf


Paygate-Schnittstelle

Definitionen

Datenformate:

FormatBeschreibung

a

alphabetisch

as

alphabetisch mit Sonderzeichen

n

numerisch

an

alphanumerisch

ans

alphanumerisch mit Sonderzeichen

ns

numerisch mit Sonderzeichen

bool

Bool’scher Ausdruck (true oder false)

3

feste Länge mit 3 Stellen/Zeichen

..3

variable Länge mit maximal 3 Stellen/Zeichen

enum

Aufzählung erlaubter Werte

dttm

ISODateTime (JJJJ-MM-TTThh:mm:ss)


Abkürzungen:

AbkürzungBeschreibung

CND

Bedingung (condition)

M

Pflicht (mandatory)

O

optional

C

bedingt (conditional)


Hinweis: Bitte beachten Sie, dass die Bezeichnungen der Parameter in Groß- oder Kleinbuchstaben zurückgegeben werden können.


PayMorrow Rechnungs- und Lastschriftkauf

Ein Zahlungsvorgang mit PayMorrow besteht aus mehreren Transaktionsschritten, die teils optional und situationsabhängig sind. Dafür bietet die PayMorrow-Schnittstelle 12 verschiedene Requests, die teilweise auch unterschiedlich einsetzbar sind.

Zusätzlich benötigt PayMorrow beim Anlegen oder spätestens bei der Bestätigung einer Autorisierung eine möglichst eindeutige DeviceID, die der Händler selbst vergeben kann. Dafür sollte eine UUID mit 128bit genutzt werden, die bei der Kommunikation mit dem Browser des Kunden generiert und dann in einem der Requests an das Paygate übergeben wird.

Eine Zahlung mit PayMorrow beginnt stets damit, eine Autorisierung anzulegen, die gegebenenfalls noch aktualisiert werden kann. Anschließend muss diese Autorisierung bestätigt werden. Optional lässt sich auch noch vor der Buchung eine erhaltene TransID einer Bestellung ändern. Die Buchung oder Teilbuchung von Zahlungen erfolgt über die übliche Buchungsschnittstelle. Beachten Sie bei PayMorrow, dass Sie einen Zahlungseingang auf einem anderen Wege (Überweisung) unbedingt auch auf diese Weise in der Buchung vermerken müssen. Sofern nötig, können Sie eine Rechnungsnummer optional noch nach der Buchung aktualisieren. Den Status eines Vorgangs ermitteln Sie gegebenenfalls über eine Abfrage. Außerdem können Sie optional den Termin für eine Bestellung oder einzelne Rechnungen dazu verschieben, indem Sie diese pausieren. Weiterhin sind Storno sowie Gutschrift und Teilgutschrift über die üblichen Schnittstellen möglich.



PayMorrow-Autorisierung anlegen/aktualisieren

Um eine Zahlung mit PayMorrow über eine Server-zu-Server-Verbindung zu initialisieren oder eine bestehend Autorisierung zu aktualisieren, 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 zu verschlüsselnden Ü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

TransaktionsID, die für jede Zahlung eindeutig sein muss

PayID

an32

C

Pflicht bei EventToken=11: Vom Paygate vergebene ID für die Zahlung, z.B. zur Referenzierung in Batch-Dateien.

RefNr

ns..30

M

eindeutige Referenznummer

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. Nur EUR zulässig.

TaxAmount

n..10

M

Steuerbetrag der gesamten Bestellung 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.

MAC

an64

M

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

OrderDesc

ans..384

M

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

EventToken

a2

M

10 für prepareOrder (Autorisierung anlegen)

11 für updateOrder (Autorisierung aktualisieren)

TermsAndConditions

a..3

M

YES/NO

ArticleList

ans..1024

M

Artikelliste mit folgenden Parametern:

„;“ trennt die einzelnen Parameter

„+“ trennt mehrere Artikel

Quantity;ArticleID;Name;Type;Category;UnitPriceGross;GrossAmount;VatRate;VatAmount

Mögliche Werte für „Type“: GOODS, VOUCHER, SHIPPING, PAYMENT_FEE

Bitte entnehmen Sie die vorgegebenen Werte für „Category“ aus der Paymorrow-Spezifikation.

Beispiel „VatRate“: für 19% übergeben Sie 1900

CustomerID

ans..50

O

Kundennummer

Title

ans..20

O

Titel, z.B. Dr.

Gender

a1

M

Geschlecht (M=male / F=female)

FirstName

ans..50

M

Vorname

LastName

ans..100

M

Nachname

Phone

ans..20

O

Telefonnummer

MobileNo

ans..50

O

Mobiltelefonnummer

e-mail

ans..80

M

E-Mail-Adresse

DateOfBirth

ans8

M

Geburtsdatum im Format YYYYMMDD

bdStreet

ans..50

M

Straßenname der Rechnungsadresse

bdStreetNr

ans..5

M

Hausnummer der Rechnungsadresse

bdZIP

ans..5

M

Postleitzahl der Rechnungsadresse

bdCity

ans..50

M

Ort der Rechnungsadresse

bdCountry­Code

a3

M

Ländercode der Rechnungsadresse, dreistellig gemäß ISO 3166

sdLastName

ans..50

O

Firmenname

sdStreet

ans..50

O

Straßenname der separaten Lieferadresse

sdStreetNr

n..5

O

Hausnummer der Lieferadresse

sdStreet2

ans..50

O

Adresszusatz in der Lieferadresse

sdZIP

ans..5

O

Postleitzahl in der Lieferadresse

sdCity

ans..50

O

Ortsname in der Lieferadresse

sdCountryCode

a3

O

Ländercode der Lieferadresse, dreistellig gemäß ISO 3166

IPAddr

ans..15

O

IP-Adresse des Kunden

BrowserSessionID

ans..50

M

SessionID des Kunden

CookiesID

ans..50

M

CookieID des Kunden

BrowserHeader

ans..100

M

BrowserHeader des Kunden

Language

a2

M

Sprache: DE

IBAN

ans..34

O

International Bank Account Number

BIC

ans..11

O

Bank Identifier Code

MandateProvided

a..3

O

SEPA-Mandat erteilt YES / NO

RPMethod

a..10

O

INVOICE / SDD (SEPA-Lastschrift)

Wenn nichts übergeben ist, werden beide Zahlarten validiert, sonst validiert PayMorrow nur diese.

CustomerHistory

ans..1024

O

Einkaufsverlauf des Kunden in der Form:

OrderDate;totalAmount;RPMethod;Paymentstatus

OrderDate = YYYY-MM-DD

Paymentstatus = PAID,NOT_PAID,IN_DUNNING_PROCESS

„+“ trennt weitere Einträge

ShoppingDuration

n..100

O

Einkaufsdauer in Millisekunden

CheckoutDuration

n..100

O

Checkout-Dauer in Millisekunden

DeviceID

ans..100

O

Eindeutige Geräte-ID

Parameter für PayMorrow-Zahlungsinitialisierungen


Die folgende Tabelle beschreibt die Ergebnis-Parameter, die das Paygate an Ihr System 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äß Paygate Antwort-Codes (A4 Fehlercodes)

RefNr

ns..30

O

eindeutige Referenznummer des Händlers

bdStreet

ans..50

C

nur bei Korrektur durch PayMorrow: Straßenname der Rechnungsadresse

bdStreetNr

s..5

C

nur bei Korrektur durch PayMorrow: Hausnummer der Rechnungsadresse

bdZIP

ans..5

C

nur bei Korrektur durch PayMorrow: Postleitzahl der Rechnungsadresse

bdCity

ans..50

C

nur bei Korrektur durch PayMorrow: Ort der Rechnungsadresse

bdCountry­Code

a3

C

nur bei Korrektur durch PayMorrow: Ländercode der Rechnungsadresse, dreistellig gemäß ISO 3166

sdLastName

ans..50

C

nur bei Korrektur durch PayMorrow: Firmenname

sdStreet

ans..50

C

nur bei Korrektur durch PayMorrow: Straßenname der separaten Lieferadresse

sdStreetNr

n..5

C

nur bei Korrektur durch PayMorrow: Hausnummer der Lieferadresse

sdStreet2

ans..50

C

nur bei Korrektur durch PayMorrow: Adresszusatz in der Lieferadresse

sdZIP

ans..5

C

nur bei Korrektur durch PayMorrow: Postleitzahl in der Lieferadresse

sdCity

ans..50

C

nur bei Korrektur durch PayMorrow: Ortsname in der Lieferadresse

sdCountryCode

a3

C

nur bei Korrektur durch PayMorrow: Ländercode der Lieferadresse, dreistellig gemäß ISO 3166

InvoiceStatus

a..20

M

VALIDATED / NOT_VALIDATED

InvoiceDeclineType

ans..20

M


InvoiceDeclineCommunicated

ans..512

M

Mögliche detaillierte Rückmeldung für den Kunden bezüglich Rechnungskauf

SDDStatus

a..20

M

VALIDATED / NOT_VALIDATED

SDDDeclineType

ans..20

M


SDDDeclineCommunicated

ans..512

M

Mögliche detaillierte Rückmeldung für den Kunden bezüglich SEPA-Lastschrift

CodeExt

n3

O

Weitergeleitet von Paymorrow: error_1_code

ErrorText

ans..255

O

Weitergeleitet von Paymorrow: error_1_technicalDesc + ";" + error_1_consumerShortDesc

CodeExt2

n3

O

Weitergeleitet von Paymorrow: error_2_code

ErrorText2

ans..255

O

Weitergeleitet von Paymorrow: error_2_technicalDesc + ";" + error_2_consumerShortDesc

CodeExt[n]

n3

O

Weitergeleitet von Paymorrow: error_[n]_code

ErrorText[n]

ans..255

O

Weitergeleitet von Paymorrow, bis 15 Wertepaare: error_[n]_technicalDesc + ";" + error_[n]_consumerShortDesc

Antwort-Parameter für PayMorrow-Zahlungsinitialisierung



PayMorrow-Autorisierung bestätigen

Um eine PayMorrow-Autorisierung zu bestätigen, 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.

PayID

an32

M

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

MAC

an64

M

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

EventToken

a2

M

13 für ConfirmOrder (Autorisierung bestätigen)

RPMethod

a..10

C

Pflicht, wenn INVOICE und SDD validiert worden sind

DeviceID

ans..100

C

Pflicht, wenn noch nicht übergeben: Eindeutige Geräte-ID

Parameter zur Bestätigung einer PayMorrow-Autorisierung


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

TransaktionsID, die für jede Zahlung eindeutig sein muss

Status

a..50

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äß Paygate Antwort-Codes (A4 Fehlercodes)

RefNr

ns..30

M

Eindeutige Referenznummer

CodeExt

n3

O

Weitergeleitet von Paymorrow: error_1_code

ErrorText

ans..255

O

Weitergeleitet von Paymorrow: error_1_technicalDesc + ";" + error_1_consumerShortDesc

CodeExt2

n3

O

Weitergeleitet von Paymorrow: error_2_code

ErrorText2

ans..255

O

Weitergeleitet von Paymorrow: error_2_technicalDesc + ";" + error_2_consumerShortDesc

CodeExt[n]

n3

O

Weitergeleitet von Paymorrow: error_[n]_code

ErrorText[n]

ans..255

O

Weitergeleitet von Paymorrow, bis 15 Wertepaare: error_[n]_technicalDesc + ";" + error_[n]_consumerShortDesc

Antwort-Parameter bei Bestätigung einer PayMorrow-Autorisierung



PayMorrow-TransID einer Bestellung ändern

Um die TransID einer PayMorrow-Bestellung zu ändern, etwa eine vorläufige Bestellnummer in eine endgültige Bestellnummer, 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.

PayID

an32

M

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

TransID

ans..64

M

Transaktionsnummer des Händlers, die als Bestellnummer verwendet wird

MAC

an64

M

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

EventToken

a2

M

12 für updateOrderID (Bestellnummer ändern)

Parameter zum Ändern der PayMorrow-TransID


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

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äß Paygate Antwort-Codes (A4 Fehlercodes)

RefNr

ns..30

M

Eindeutige Referenznummer

CodeExt

n3

O

Weitergeleitet von Paymorrow: error_1_code

ErrorText

ans..255

O

Weitergeleitet von Paymorrow: error_1_technicalDesc + ";" + error_1_consumerShortDesc

CodeExt2

n3

O

Weitergeleitet von Paymorrow: error_2_code

ErrorText2

ans..255

O

Weitergeleitet von Paymorrow: error_2_technicalDesc + ";" + error_2_consumerShortDesc

CodeExt[n]

n3

O

Weitergeleitet von Paymorrow: error_[n]_code

ErrorText[n]

ans..255

O

Weitergeleitet von Paymorrow, bis 15 Wertepaare: error_[n]_technicalDesc + ";" + error_[n]_consumerShortDesc

Antwort-Parameter für Änderung der PayMorrow-TransID



PayMorrow-Zahlungsvorgang buchen (Komplett- / Teilbuchung)

Um eine Buchung oder Teilbuchung für eine PayMorrow-Bestellung auszuführen oder ei-nen anderen Zahlungseingang zu vermerken, 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.

PayID

an32

M

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

TransID

ans..64

MC

Transaktionsnummer des Händlers

Bei EventToken=27 optional: dient zum Begleichen einer Bestellung bzw. aller zugehörigen Rechnungen nach Übergabe der ursprünglichen TransID

Amount

n..10

M

Betrag der zu buchenden Bestellung 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. Nur EUR zulässig.

TaxAmount

n..10

M

Steuerbetrag der zu buchenden Bestellung 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.

MAC

an64

M

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

RefNr

ns..30

MC

Eindeutige Referenz / Rechnungsnummer

Bei EventToken=27 optional: zum Begleichen einer bestimmten Rechnung nach Übergabe der ursprünglichen RefNr

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.

EventToken

a2

M

21 für Teilbuchung

22 für Teilbuchung mit Freigabe des restlichen autorisierten Betrages

27 für registerDirectPayment (Buchung eines Zahlungseingangs über einen anderen Weg)

ArticleList

ans..1024

C

Nicht bei EventToken=27; Pflicht bei EventTo-ken=21 oder 22

Artikelliste mit folgenden Parametern:

„;“ trennt die einzelnen Parameter
„+“ trennt mehrere Artikel

Quantity;ArticleID;Name;Type;Category;UnitPriceGross;GrossAmount;VatRate;VatAmount

Mögliche Werte für „Type“: GOODS, VOUCHER, SHIPPING, PAYMENT_FEE

Bitte entnehmen Sie die vorgegebenen Werte für „Category“ aus der Paymorrow-Spezifikation.

Beispiel „VatRate“: für 19% übergeben Sie 1900

Optional und nur nach Vereinbarung mit PayMorrow auch folgende kurze Artikelliste:

VatRate;VatAmount

Parameter zum Buchen einer PayMorrow-Zahlung


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

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äß Paygate Antwort-Codes (A4 Fehlercodes)

RefNr

ns..30

M

Eindeutige Referenz / Rechnungsnummer

CodeExt

n3

O

Weitergeleitet von Paymorrow: error_1_code

ErrorText

ans..255

O

Weitergeleitet von Paymorrow: error_1_technicalDesc + ";" + error_1_consumerShortDesc

CodeExt2

n3

O

Weitergeleitet von Paymorrow: error_2_code

ErrorText2

ans..255

O

Weitergeleitet von Paymorrow: error_2_technicalDesc + ";" + error_2_consumerShortDesc

CodeExt[n]

n3

O

Weitergeleitet von Paymorrow: error_[n]_code

ErrorText[n]

ans..255

O

Weitergeleitet von Paymorrow, bis 15 Wertepaare: error_[n]_technicalDesc + ";" + error_[n]_consumerShortDesc

Antwort-Parameter beim Buchen einer PayMorrow-Zahlung



PayMorrow-Rechnungsnummer aktualisieren

Um eine zum Zeitpunkt der Buchung noch nicht bekannte Rechnungsnummer einer PayMorrow-Zahlung später noch zu aktualisieren, 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.

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

MAC

an64

M

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

RefNr

ns..30

M

Eindeutige Referenz / Rechnungsnummer

EventToken

a2

M

24 für updateInvoiceID (Rechnungsnummer aktualisieren)

Parameter zur Aktualisierung einer Rechnungsnummer bei PayMorrow-Zahlungen


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

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äß Paygate Antwort-Codes (A4 Fehlercodes)

RefNr

ns..30

M

Eindeutige Referenz / Rechnungsnummer

CodeExt

n3

O

Weitergeleitet von Paymorrow: error_1_code

ErrorText

ans..255

O

Weitergeleitet von Paymorrow: error_1_technicalDesc + ";" + error_1_consumerShortDesc

CodeExt2

n3

O

Weitergeleitet von Paymorrow: error_2_code

ErrorText2

ans..255

O

Weitergeleitet von Paymorrow: error_2_technicalDesc + ";" + error_2_consumerShortDesc

CodeExt[n]

n3

O

Weitergeleitet von Paymorrow: error_[n]_code

ErrorText[n]

ans..255

O

Weitergeleitet von Paymorrow, bis 15 Wertepaare: error_[n]_technicalDesc + ";" + error_[n]_consumerShortDesc

Antwort-Parameter bei Aktualisierung der Rechnungsnummer einer PayMorrow-Zahlung


PayMorrow-Bestellstatus abfragen

Um den Status einer PayMorrow-Bestellung abzufragen, 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.

PayID

an32

M

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

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. Nur EUR zulässig.

MAC

an64

M

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

EventToken

a2

M

52 für getOrderStatus (Bestellstatus abfragen)

Parameter zur Statusabfrage einer PayMorrow-Bestellung


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

Status

a..50

M

OK oder FAILED

LastStatus

a..50

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äß Paygate Antwort-Codes (A4 Fehlercodes)

RefNr

ns..30

M

Eindeutige Referenznummer

CodeExt

n3

O

Weitergeleitet von Paymorrow: error_1_code

ErrorText

ans..255

O

Weitergeleitet von Paymorrow: error_1_technicalDesc + ";" + error_1_consumerShortDesc

CodeExt2

n3

O

Weitergeleitet von Paymorrow: error_2_code

ErrorText2

ans..255

O

Weitergeleitet von Paymorrow: error_2_technicalDesc + ";" + error_2_consumerShortDesc

CodeExt[n]

n3

O

Weitergeleitet von Paymorrow: error_[n]_code

ErrorText[n]

ans..255

O

Weitergeleitet von Paymorrow, bis 15 Wertepaare: error_[n]_technicalDesc + ";" + error_[n]_consumerShortDesc

Antwort-Parameter bei Statusabfrage einer PayMorrow-Bestellung



PayMorrow-Zahlungen pausieren

Um eine Bestellung oder Zahlung mit PayMorrow zu pausieren, 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.

PayID

an32

M

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

XID

an32

O

XID der zu pausierenden Transaktion

Wenn keine XID übergeben wird, pausiert die gesamte Bestellung.

MAC

an64

M

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

RefNr

ns..30

C

Pflicht bei EventToken=26: Eindeutige Referenznummer

EventToken

a2

M

für postponeOrderCollection (Buchung):

26 (pausiert die mit XID angegebene Buchung)

53 (pausiert alle zur Zahlung gehörigen Buchungen)

NumberOfDays

n..3

M

Anzahl der Tage, um die die Bestellung/Rechnung zurückgestellt werden soll

Parameter zur Pausierung von PayMorrow-Zahlungen


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

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äß Paygate Antwort-Codes (A4 Fehlercodes)

RefNr

ns..30

M

Eindeutige Referenznummer

CodeExt

n3

O

Weitergeleitet von Paymorrow: error_1_code

ErrorText

ans..255

O

Weitergeleitet von Paymorrow: error_1_technicalDesc + ";" + error_1_consumerShortDesc

CodeExt2

n3

O

Weitergeleitet von Paymorrow: error_2_code

ErrorText2

ans..255

O

Weitergeleitet von Paymorrow: error_2_technicalDesc + ";" + error_2_consumerShortDesc

CodeExt[n]

n3

O

Weitergeleitet von Paymorrow: error_[n]_code

ErrorText[n]

ans..255

O

Weitergeleitet von Paymorrow, bis 15 Wertepaare: error_[n]_technicalDesc + ";" + error_[n]_consumerShortDesc

Antwort-Parameter bei Pausierung von PayMorrow-Zahlungen


Storno von PayMorrow-Zahlungen

Um eine Bestellung oder Zahlung mit PayMorrow zu stornieren, 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.

PayID

an32

M

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

XID

an32

C

Pflicht bei EventToken=42: XID einer bestimmten Buchung

Amount

n..10

M

Betrag der zu stornierenden Bestellung/Buchung 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. Nur EUR zulässig.

MAC

an64

O

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.

EventToken

a2

M

40 für Storno der Bestellung

41 für Storno der Buchung

42 für Storno einer bestimmten Teilbuchung

Parameter für Storno einer PayMorrow-Zahlung


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

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äß Paygate Antwort-Codes (A4 Fehlercodes)

RefNr

ns..30

M

Eindeutige Referenznummer

CodeExt

n3

O

Weitergeleitet von Paymorrow: error_1_code

ErrorText

ans..255

O

Weitergeleitet von Paymorrow: error_1_technicalDesc + ";" + error_1_consumerShortDesc

CodeExt2

n3

O

Weitergeleitet von Paymorrow: error_2_code

ErrorText2

ans..255

O

Weitergeleitet von Paymorrow: error_2_technicalDesc + ";" + error_2_consumerShortDesc

CodeExt[n]

n3

O

Weitergeleitet von Paymorrow: error_[n]_code

ErrorText[n]

ans..255

O

Weitergeleitet von Paymorrow, bis 15 Wertepaare: error_[n]_technicalDesc + ";" + error_[n]_consumerShortDesc

Antwort-Parameter bei Storno von PayMorrow-Zahlungen



PayMorrow-Gutschrift erteilen

Um eine Voll- oder Teilgutschrift auf eine vorherige Buchung mit PayMorrow zu erteilen, 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.

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. Hier muss die XID der Buchung übergeben werden, auf welche die Gutschrift erfolgen soll.

Amount

n..10

M

Betrag der gutzuschreibenden Bestellung/Buchung 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.

TaxAmount

n..10

M

Steuerbetrag der gutzuschreibenden Bestellung/Buchung 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.

MAC

an64

O

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

RefNr

ns..30

M

Eindeutige Referenznummer für die Gutschrift

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.

EventToken

a2

M

30 Gutschrift über vollen Betrag

31 Gutschrift über Teilbetrag

35 Gutschrift über vollen Betrag mit Erhalt der Autorisierung für den Betrag

36 Gutschrift über Teilbuchung mit Erhalt der Autorisierung für den Betrag

ArticleList

ans..1024

C

(nur bei Teilgutschriften, EventToken=31 oder 36)

Artikelliste mit folgenden Parametern:

„;“ trennt die einzelnen Parameter
„+“ trennt mehrere Artikel

Quantity;ArticleID;Name;Type;Category;UnitPriceGross;GrossAmount;VatRate;VatAmount

Mögliche Werte für „Type“: GOODS, VOUCHER, SHIPPING, PAYMENT_FEE

Bitte entnehmen Sie die vorgegebenen Werte für „Category“ aus der Paymorrow-Spezifikation.

Beispiel „VatRate“: für 19% übergeben Sie 1900

Optional und nur nach Vereinbarung mit PayMorrow auch folgende kurze Artikelliste:

VatRate;VatAmount

Parameter für Gutschrift einer PayMorrow-Zahlung


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

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äß Paygate Antwort-Codes (A4 Fehlercodes)

RefNr

ns..30

M

Eindeutige Referenznummer

CodeExt

n3

O

Weitergeleitet von Paymorrow: error_1_code

ErrorText

ans..255

O

Weitergeleitet von Paymorrow: error_1_technicalDesc + ";" + error_1_consumerShortDesc

CodeExt2

n3

O

Weitergeleitet von Paymorrow: error_2_code

ErrorText2

ans..255

O

Weitergeleitet von Paymorrow: error_2_technicalDesc + ";" + error_2_consumerShortDesc

CodeExt[n]

n3

O

Weitergeleitet von Paymorrow: error_[n]_code

ErrorText[n]

ans..255

O

Weitergeleitet von Paymorrow, bis 15 Wertepaare: error_[n]_technicalDesc + ";" + error_[n]_consumerShortDesc

Antwort-Parameter bei Gutschrift einer PayMorrow-Zahlung



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 einer Transaktion mit PayMorrow ü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

Capture

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)

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)

Reverse

1.0 / 2.0

Standardversion ohne Rückgabe von Code

 

1.x / 2x.

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

Beschreibung der möglichen Batch-Versionen


Der Aufbau für eine Buchung oder Gutschrift in einer einzureichenden Batch-Datei sieht folgendermaßen aus:

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

PAYMORROW,Capture,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID>,<TaxAmount>

PAYMORROW,Credit,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID>,<TaxAmount>

PAYMORROW,Reverse,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID>

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 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, RatePay für Transaktionen

Action

a..20

M

Der Action-Parameter definiert die Art der Transaktion:

Capture (Buchung)

Credit (Gutschrift)

Reverse (Storno)

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

O

eindeutige Referenznummer

PayID

an32

M

Vom Paygate vergebene ID für diese Transaktion

TaxAmount

n..10

M

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

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>

PAYMORROW,Capture,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID>,<TaxAmount>,<Status>,<Code>

PAYMORROW,Credit,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID>,<TaxAmount>,<Status>,<Code>

PAYMORROW,Reverse,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID>,<Status>,<Code>

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:

Capture (Buchung)

Credit (Gutschrift)

Reverse (Storno)

PayID

an32

M

Vom Paygate vergebene ID für diese Transaktion

Status

a..50

M

OK oder FAILED

Code

n8

M

Fehlercode gemäß Paygate Antwort-Codes (A4 Fehlercodes)

Beschreibung der Ergebnis-Parameter im Datensatz von Batch-Dateien