• DeutschEnglish

iCard

Logo

Info

iCard

Typ

Zahlungen per Kreditkarte

Einleitung

Weitere Informationen zu Acquirern und Anbindung, Integration mit dem Computop Paygate und Implementierung von 3-D Secure (2.x) finden Sie im Kapitel Kreditkarten - Allgemeine Einführung.

Spezifische Parameter für iCard

Für die Kreditkartenanbindung BankSys sind neben den oben beschriebenen allgemeinen Parametern noch nachstehende Parameter zusätzlich zu übergeben. Eine Autorisierung mittels 3-D Secure ist möglich.

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, welche zusätzlich zu denen im Abschnitt "Allgemein per Formular" bzw. "Allgemein per Server-zu-Server" übergeben werden müssen:

Key

Format

CND

Beschreibung

RefNr

ns..30

O

Eindeutige Referenznummer des Händlers, welche als Auszahlungsreferenz in der entsprechenden Acquirer EPA-Datei angegeben wird. Bitte beachten Sie, ohne die Übergabe einer eigenen Auszahlungsreferenz können Sie die EPA-Transaktionen nicht zuordnen, zusätzlich kann das Computop Settlement File (CTSF) auch nicht zusätzlich angereichert werden.

Es sind ausschließlich ASCII-Zeichen erlaubt. Sonderzeichen wie ("Umlaute", ...) sind nicht erlaubt und müssen ggf. durch ASCII-Zeichen ersetzt werden (z.B. ü → ue, é → e, ...).

CustomerID

ans..255

O

Zugangsdaten des Kunden auf der Checkout-Seite des Händlers (E-Mail, ID, Telefonnummer oder Namen)

OrderDesc

ans..768

O

Beschreibung der gekauften Waren, Einzelpreise etc.

RTF

a1

O

bei wiederkehrenden Zahlungen (Abos): I = Initialzahlung eines neuen Abos, R = Wiederkehrende Zahlung (Recurring)

Zusätzliche Parameter für Kreditkartenzahlungen

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

diese Antwort-Parameter kommen zusätzlich zu den Standard-Parametern aus den Abschnitten "Allgemein per Formular" bzw. "Allgemein per Server-zu-Server"

es können jederzeit neue Parameter hinzugefügt bzw. die Reihenfolge geändert werden

die Parameter (z.B. MerchantId, RefNr) sollten nicht auf Groß-/Kleinschreibung geprüft werden

Key

Format

CND

Beschreibung

RefNr

ns..30

O

Eindeutige Referenznummer des Händlers, welche als Auszahlungsreferenz in der entsprechenden Acquirer EPA-Datei angegeben wird. Bitte beachten Sie, ohne die Übergabe einer eigenen Auszahlungsreferenz können Sie die EPA-Transaktionen nicht zuordnen, zusätzlich kann das ComputopSettlement File (CTSF) auch nicht zusätzlich angereichert werden.

Es sind ausschließlich ASCII-Zeichen erlaubt. Sonderzeichen wie ("Umlaute", ...) sind nicht erlaubt und müssen ggf. durch ASCII-Zeichen ersetzt werden (z.B. ü → ue, é → e, ...).

ErrorText

ans..

OC

Fehlertext von iCard, wenn mit Computop Helpdeskabgesprochen. Wird nur zurückgegeben, wenn der Händler ResponseExtended=Yes konfiguriert hat.

CodeExt

n..3

OC

Fehlercode von iCard, wenn mit Computop Helpdesk abgesprochen. Wird nur zurückgegeben, wenn der Händler ResponseExtended=Yes konfiguriert hat.

ApprovalCode

ans..6

O

vom Kartenaussteller zurückgegebener ApprovalCode oder Autorisierungscode

Zusätzliche Ergebnis-Parameter für Kreditkartenzahlungen

Kreditkarten - Kreditkartenformular

Weitere Informationen zur Kreditkartenabwicklung über Formulare finden Sie im Kapitel Kreditkartenformular (paySSL).

Kreditkarten - Server-2-Server Integration

Weitere Informationen zur Kreditkartenabwicklung über Server-zu-Server-Kommunikation finden Sie im Kapitel Server-2-Server Integration.

Buchung / Gutschrift / Storno

Capture

Buchungen sind über eine Server-zu-Server-Kommunikation möglich. Um eine Buchung (Capture) über eine Server-zu-Server-Verbindung auszuführen, verwenden Sie bitte folgende URL:

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

Hinweis: Bitte beachten Sie die Reservierungs- / Autorisierungsfristen Ihres Acquirers (siehe AGBs), damit Sie als Händler sicherstellen, dass die Abbuchungen in der korrekten Frist an unserem Paygate eingereicht 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:

KeyRESTFormatCNDDescription

MerchantID

BasicAuth.Username

ans..30

M

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

PayID

"paymentId": "..."

an32

M

Vom Paygate vergebene ID für die Zahlung; z.B. zur Referenzierung in Batch-Dateien sowie im Capture- oder Credit-Request.

TransID

"transactionId": "..."

ans..64

M

TransaktionsID, die für jede Zahlung eindeutig sein muss

Bitte beachten Sie bei einigen Anbindungen die abweichenden Formate, die bei den spezifischen Parametern angegeben sind.

RefNr

"referenceNumber": "..."

ns..30

C

Eindeutige Referenznummer des Händlers, welche als Auszahlungsreferenz in der entsprechenden Acquirer EPA-Datei angegeben wird. Bitte beachten Sie, ohne die Übergabe einer eigenen Auszahlungsreferenz können Sie die EPA-Transaktionen nicht zuordnen, zusätzlich kann das Computop Settlement File (CTSF) auch nicht zusätzlich angereichert werden.

nicht bei EVO Payments, bei CardComplete im Format an..25, bei Cofidis im Format n..15, bei Omnipay im Format ns..15, bei RBI im Format ns..20)

Es sind ausschließlich ASCII-Zeichen erlaubt. Sonderzeichen wie ("Umlaute", ...) sind nicht erlaubt und müssen ggf. durch ASCII-Zeichen ersetzt werden (z.B. ü → ue, é → e, ...).

Amount

"amount": { "value": ...}

n..10

M

Betrag in der kleinsten Währungseinheit (z.B. EUR Cent). Bitte wenden Sie sich an den Computop Helpdesk, wenn Sie Beträge < 100 (kleinste Währungseinheit) buchen möchten.

Currency

"amount": { "currency": "..."}

a3

M

Währung, drei Zeichen DIN / ISO 4217, z.B. EUR, USD, GBP. Hier eine Übersicht: A1 Währungstabelle

MAC

–––

an64

M

Hash Message Authentication Code (HMAC) mit SHA-256-Algorithmus. Details finden Sie hier:

ReqId

"requestId": "..."

ans..32

O

Um Doppelzahlungen (z.B. durch ETM) zu vermeiden, übergeben Sie einen alphanumerischen Wert, der Ihre Transaktion oder Aktion identifiziert und nur einmal vergeben werden darf. Falls die Transaktion oder Aktion mit derselben ReqID erneut eingereicht wird, führt das Computop Paygate keine Zahlung oder weitere Aktion aus, sondern gibt nur den Status der ursprünglichen Transaktion oder Aktion zurück.

Bitte beachten Sie, dass das Computop Paygate für die erste initiale Aktion (Authentifizierung/Autorisierung) einen abgeschlossenen Transaktionsstatus haben muss. Dies gilt nicht für 3-D Secure Authentifizierungen, die durch einem Timeout beendet werden. Der Status 3-D Secure Timeout gilt nicht als abgeschlossener Status, bei dem ReqID-Funktionalität am Paygate nicht greift. Einreichungen mit identischer ReqID auf einen offenen Status werden regulär verarbeitet.

Hinweis: Bitte beachten Sie, dass eine ReqID nur 12 Monate gültig ist, danach wird sie vom Paygate gelöscht.

FinishAuth

"finishAuth": "..."

a1

C

Nur bei ETM: Übergeben Sie den Wert <Y>, um bei Teilbuchungen die Autorisierungserneuerung oder die Reservierung des Restbetrages zu stoppen. Bitte nutzen Sie den Parameter nur, wenn Sie die Zusatzfunktion ETM (Erweitertes Transaktions-Managament) nutzen. (Nicht bei Clearhaus)

Textfeld1

"cardHolder": { "name": "..."}

ans..30

O

Karteninhaber-Information: Name (Nicht bei Clearhaus)

Für Banksys: Name des Händlers.Bei VISA-Transaktionen sind bis zu 25 Zeichen erlaubt, bei MasterCard nur bis zu 22.

Textfeld2

"cardHolder": { "city": "..."}

ans..30

O

Karteninhaber-Information: Ort (Nicht bei Clearhaus)

Für Banksys: Ort des Händlers. Der Wert wird nach 13 Zeichen abgeschnitten.

CHDesc

–––

ans..22

OC

Nur bei Clearhaus: Text, der auf der Kreditkartenabrechnung angezeigt wird. Nur ASCII druckbare Zeichen von 0x20 bis 0x7E

Parameter für Buchungen von Kreditkartenzahlungen

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

es können jederzeit neue Parameter hinzugefügt bzw. die Reihenfolge geändert werden

die Parameter (z.B. MerchantId, RefNr) sollten nicht auf Groß-/Kleinschreibung geprüft werden

KeyRESTFormatCNDDescription

mid

"merchantId": "..."

ans..30

M

HändlerID, die von Computop vergeben wird

PayID

"paymentId": "..."

an32

M

Vom Paygate vergebene ID für die Zahlung; z.B. zur Referenzierung in Batch-Dateien sowie im Capture- oder Credit-Request.

XID

"xId": "..."

an32

M

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

TransID

"transactionId": "..."

ans..64

M

TransaktionsID, die für jede Zahlung eindeutig sein muss

Bitte beachten Sie bei einigen Anbindungen die abweichenden Formate, die bei den spezifischen Parametern angegeben sind.

Status

"status": "OK"

"status": "FAILED"

a..50

M

OK (URLSuccess) oder FAILED (URLFailure)

Description

"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

"code": ...

an8

M

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

RefNr

"referenceNumber": "..."

ns..30

C

Eindeutige Referenznummer des Händlers, welche als Auszahlungsreferenz in der entsprechenden Acquirer EPA-Datei angegeben wird. Bitte beachten Sie, ohne die Übergabe einer eigenen Auszahlungsreferenz können Sie die EPA-Transaktionen nicht zuordnen, zusätzlich kann das Computop Settlement File (CTSF) auch nicht zusätzlich angereichert werden.

nicht bei EVO Payments, bei CardComplete im Format an..25, bei Cofidis im Format n..15, bei Omnipay im Format ns..15, bei RBI im Format ns..20)

Es sind ausschließlich ASCII-Zeichen erlaubt. Sonderzeichen wie ("Umlaute", ...) sind nicht erlaubt und müssen ggf. durch ASCII-Zeichen ersetzt werden (z.B. ü → ue, é → e, ...).

Aid

"authorizationId": "..."

n6

OC

Nur bei Card Complete: von Card Complete zurückgegebene Autorisierungs-ID

Amount

"amountValue": "..."

n..10

OC

Nur bei Clearhaus: Betrag in der kleinsten Währungseinheit (z.B. EUR Cent)

Sollte der tatsächliche Betrag vom angefragten Betrag abweichen, wird dieser zurückgegeben.

CodeExt

"externalErrorCode": "..."

n5

OC

Nur bei Clearhaus: Nur wenn konfiguriert: externer Fehlercode (nachgelagertes System).

ErrorText

"errorText": "..."

ans.128

OC

Nur bei Clearhaus: Detaillierte Clearhaus Fehlermeldung.

Wird nur bei Status=FAILED zurückgegeben. Nutzung nur in Abstimmung mit Computop Helpdesk möglich.

TransactionID

"clearhausTransactionId": "..."

ans36

OC

Nur bei Clearhaus: Transaktionsnummer von Clearhaus

TID

"cofidisTransactionId": "..."

n..15

M

Nur bei Cofidis: Wenn RefNr übergeben wurde, wird dieser Wert zurückgegeben. Anderenfalls werden die ersten 15 Stellen der TransactionID zurückgegeben.

Ergebnis-Parameter für Buchungen von Kreditkartenzahlungen

Buchung (Teilbuchung)

Buchungen sind mittels Server-to-Server Kommunikation möglich. Für Teilbuchungen ist ein separates JSON-Objekt als Parameter erforderlich Um eine Buchung auszuführen, verwenden Sie bitte folgende URL:

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

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:

KeyRESTFormatCNDDescription

MerchantID

BasicAuth.Username

ans..30

M

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

PayID

"paymentId": "..."

an32

M

Vom Paygate vergebene ID für die Zahlung; z.B. zur Referenzierung in Batch-Dateien sowie im Capture- oder Credit-Request.

TransID

"transactionId": "..."

ans..64

M

Ihre eigene TransaktionsID, die für jede Zahlung eindeutig sein muss

RefNr

"referenceNumber": "..."

ns..30

O

Eindeutige Referenznummer des Händlers, welche als Auszahlungsreferenz in der entsprechenden Acquirer EPA-Datei angegeben wird. Bitte beachten Sie, ohne die Übergabe einer eigenen Auszahlungsreferenz können Sie die EPA-Transaktionen nicht zuordnen, zusätzlich kann das  Computop Settlement File (CTSF) auch nicht zusätzlich angereichert werden.

Es sind ausschließlich ASCII-Zeichen erlaubt. Sonderzeichen wie ("Umlaute", ...) sind nicht erlaubt und müssen ggf. durch ASCII-Zeichen ersetzt werden (z.B. ü → ue, é → e, ...).

Amount

"amount": { "value": ...}

n..10

M

Betrag in der kleinsten Währungseinheit (z.B. EUR Cent). Bitte wenden Sie sich an den Computop Helpdesk, wenn Sie Beträge < 100 (kleinste Währungseinheit) buchen möchten.

Currency

"amount": { "currency": "..."}

a3

M

Währung, drei Zeichen DIN / ISO 4217, z.B. EUR, USD, GBP. Hier eine Übersicht: A1 Währungstabelle

MAC

–––

an64

M

Hash Message Authentication Code (HMAC) mit SHA-256-Algorithmus. Details finden Sie hier:

ReqId

"requestId": "..."

ans..32

O

Um Doppelzahlungen (z.B. durch ETM) zu vermeiden, übergeben Sie einen alphanumerischen Wert, der Ihre Transaktion oder Aktion identifiziert und nur einmal vergeben werden darf. Falls die Transaktion oder Aktion mit derselben ReqID erneut eingereicht wird, führt das Computop Paygate keine Zahlung oder weitere Aktion aus, sondern gibt nur den Status der ursprünglichen Transaktion oder Aktion zurück.

Bitte beachten Sie, dass das Computop Paygate für die erste initiale Aktion (Authentifizierung/Autorisierung) einen abgeschlossenen Transaktionsstatus haben muss. Dies gilt nicht für 3-D Secure Authentifizierungen, die durch einem Timeout beendet werden. Der Status 3-D Secure Timeout gilt nicht als abgeschlossener Status, bei dem ReqID-Funktionalität am Paygate nicht greift. Einreichungen mit identischer ReqID auf einen offenen Status werden regulär verarbeitet.

Hinweis: Bitte beachten Sie, dass eine ReqID nur 12 Monate gültig ist, danach wird sie vom Paygate gelöscht.

ApprovalCode

ans..6

M

von der originalen Autorisierung

JSON-Objekt

captureinfo

ans..1024

M

Neuer Parameter für mehrfache Teilbuchungen. Dieser Parameter muss im JSON-Format angelegt werden.

Die einzelnen Parameter im JSON-Format sind folgende:

curIdx (M) - Format: n..2 – Eindeutige ID für diese bestimmte Buchung – Für eine Gutschrift zu genau dieser Buchung nötig,

total (M) - Format: n..2 – Mehrfachbuchung-Sequenzzähler – maximale Anzahl Buchungen pro Autorisierung – mögliche Werte 1-99

final (M) - Format: an..3 – Flag für letzte Buchung

"no" – Nicht die letzte Buchung

"yes" – Letzte Buchung – Nach dem Senden von "yes" sind kein weiteren Buchungen mehr möglich!

Dieses JSON-Beispiel kann verwendet werden. Wichtig: captureinfo=Base64-JSON (base64-codiert)

1
{
2
"$schema": "http://json-schema.org/draft-07/schema#",
3
"$id": "https://www.computop-paygate.com/schemas/captureInfo.json",
4
"title": "captureInfo",
5
"examples": [
6
// usage: capture=manual|auto|<nn>|Base64-JSON
7
{
8
"auto": "yes"
9
},
10
{
11
"manual": {
12
"final": "no"
13
}
14
},
15
{
16
"manual": {
17
"final": "no",
18
"total": 3
19
}
20
},
21
{
22
"manual": {
23
"final": "yes"
24
}
25
},
26
{
27
"manual": {
28
"final": "yes",
29
"curIdx": 2,
30
"total": 3
31
}
32
},
33
{
34
"manual": {
35
"final": "yes",
36
"total": 3
37
}
38
},
39
{
40
"delayed": {
41
"hours": 30
42
}
43
}
44
],
45
"description": "captureInfo",
46
"properties": {
47
"auto": {
48
"type": "string",
49
"enum": [
50
"yes"
51
],
52
"additionalProperties": false
53
},
54
"manual": {
55
"type": "object",
56
"properties": {
57
"final": {
58
"type": "string",
59
"enum": [
60
"yes",
61
"no"
62
]
63
},
64
"total": {
65
"type": "integer",
66
"minimum": 1,
67
"maximum": 99
68
},
69
"curIdx": {
70
"type": "integer",
71
"minimum": 1,
72
"maximum": 99
73
}
74
},
75
"required": [
76
"final"
77
],
78
"additionalProperties": false
79
},
80
"delayed": {
81
"type": "object",
82
"properties": {
83
"hours": {
84
"type": "integer",
85
"minimum": 1,
86
"maximum": 99
87
}
88
},
89
"required": [
90
"hours"
91
],
92
"additionalProperties": false
93
}
94
},
95
"oneOf": [
96
{
97
"required": [
98
"manual"
99
]
100
},
101
{
102
"required": [
103
"delayed"
104
]
105
},
106
{
107
"required": [
108
"auto"
109
]
110
}
111
],
112
"additionalProperties": false
113
}

Anfrage-Parameter für Teil-Buchungen/Capture von Kreditkartenzahlungen

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

es können jederzeit neue Parameter hinzugefügt bzw. die Reihenfolge geändert werden

die Parameter (z.B. MerchantId, RefNr) sollten nicht auf Groß-/Kleinschreibung geprüft werden

KeyRESTFormatCNDDescription

mid

"merchantId": "..."

ans..30

M

HändlerID, die von Computop vergeben wird

PayID

"paymentId": "..."

an32

M

Vom Paygate vergebene ID für die Zahlung; z.B. zur Referenzierung in Batch-Dateien sowie im Capture- oder Credit-Request.

XID

"xId": "..."

an32

M

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

TransID

"transactionId": "..."

ans..64

M

Ihre eigene TransaktionsID, die für jede Zahlung eindeutig sein muss

Status

"status": "OK"

"status": "FAILED"

a..50

M

OK (URLSuccess) oder FAILED (URLFailure)

Description

"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

"code": ...

an8

M

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

RefNr

"referenceNumber": "..."

ns..30

O

Eindeutige Referenznummer des Händlers, welche als Auszahlungsreferenz in der entsprechenden Acquirer EPA-Datei angegeben wird. Bitte beachten Sie, ohne die Übergabe einer eigenen Auszahlungsreferenz können Sie die EPA-Transaktionen nicht zuordnen, zusätzlich kann das  Computop Settlement File (CTSF) auch nicht zusätzlich angereichert werden.

Es sind ausschließlich ASCII-Zeichen erlaubt. Sonderzeichen wie ("Umlaute", ...) sind nicht erlaubt und müssen ggf. durch ASCII-Zeichen ersetzt werden (z.B. ü → ue, é → e, ...).

original_trn

n20

M

TRN der originalen Transaktion

ApprovalCode

ans..6

M

von der originalen Autorisierung

Antwort-Parameter für Teil-Buchungen/Capture von Kreditkartenzahlungen

Gutschrift mit Referenz

Gutschriften sind über eine Server-zu-Server-Kommunikation möglich. Das Paygate erlaubt einerseits Gutschriften, die sich auf eine vorher über das Paygate getätigte Buchung beziehen, andererseits können Sie Gutschriften ohne Bezugstransaktion ausführen. Dieses Kapitel beschreibt die Abwicklung von Gutschriften mit Bezugstransaktion. Wenn Sie sich bei einer Gutschrift auf eine Buchung beziehen, dann 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:

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

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:

KeyRESTFormatCNDDescription

MerchantID

BasicAuth.Username

ans..30

M

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

PayID

"paymentId": "..."

an32

M

Vom Paygate vergebene ID für die Zahlung; z.B. zur Referenzierung in Batch-Dateien sowie im Capture- oder Credit-Request.

TransID

"transactionId": "..."

ans..64

M

TransaktionsID, die für jede Zahlung eindeutig sein muss

Bitte beachten Sie bei einigen Anbindungen die abweichenden Formate, die bei den spezifischen Parametern angegeben sind.

Amount

"amount": { "value": ...}

n..10

M

Betrag in der kleinsten Währungseinheit (z.B. EUR Cent). Bitte wenden Sie sich an den Computop Helpdesk, wenn Sie Beträge < 100 (kleinste Währungseinheit) buchen möchten.

Currency

"amount": { "currency": "..."}

a3

M

Währung, drei Zeichen DIN / ISO 4217, z.B. EUR, USD, GBP. Hier eine Übersicht: A1 Währungstabelle

MAC

–––

an64

M

Hash Message Authentication Code (HMAC) mit SHA-256-Algorithmus. Details finden Sie hier:

RefNr

"referenceNumber": "..."

ns..30

C

Eindeutige Referenznummer des Händlers, welche als Auszahlungsreferenz in der entsprechenden Acquirer EPA-Datei angegeben wird. Bitte beachten Sie, ohne die Übergabe einer eigenen Auszahlungsreferenz können Sie die EPA-Transaktionen nicht zuordnen, zusätzlich kann das Computop Settlement File (CTSF) auch nicht zusätzlich angereichert werden.

(nicht bei EVO Payments, Nur bei CardComplete, bei Clearhaus (ns..30, optional, nur ASCII druckbare Zeichen von 0x20 bis 0x7E), bei RBI (ns..20, optional), bei Cofidis (n..15, optional).)

Hinweis: Für CAPN sind mehrere Teilgutschriften am selben Tag zulässig.Bitte beachten Sie, dass für jede Teilgutschrift eine separate eindeutige RefNr erforderlich ist.

Es sind ausschließlich ASCII-Zeichen erlaubt. Sonderzeichen wie ("Umlaute", ...) sind nicht erlaubt und müssen ggf. durch ASCII-Zeichen ersetzt werden (z.B. ü → ue, é → e, ...).

OrderDesc

"orderDescription": "..."

ans..768

O

Beschreibung der gutgeschriebenen Artikel, Einzelpreise, Händlerkommentar etc. (Nicht bei Clearhaus)

ReqId

"requestId": "..."

ans..32

O

Um Doppelzahlungen (z.B. durch ETM) zu vermeiden, übergeben Sie einen alphanumerischen Wert, der Ihre Transaktion oder Aktion identifiziert und nur einmal vergeben werden darf. Falls die Transaktion oder Aktion mit derselben ReqID erneut eingereicht wird, führt das Computop Paygate keine Zahlung oder weitere Aktion aus, sondern gibt nur den Status der ursprünglichen Transaktion oder Aktion zurück.

Bitte beachten Sie, dass das Computop Paygate für die erste initiale Aktion (Authentifizierung/Autorisierung) einen abgeschlossenen Transaktionsstatus haben muss. Dies gilt nicht für 3-D Secure Authentifizierungen, die durch einem Timeout beendet werden. Der Status 3-D Secure Timeout gilt nicht als abgeschlossener Status, bei dem ReqID-Funktionalität am Paygate nicht greift. Einreichungen mit identischer ReqID auf einen offenen Status werden regulär verarbeitet.

Hinweis: Bitte beachten Sie, dass eine ReqID nur 12 Monate gültig ist, danach wird sie vom Paygate gelöscht.

Textfeld1

"cardHolder": { "name": "..."}

ans..30

O

Karteninhaber-Information: Name (Nicht bei Clearhaus)

Für Banksys: Name des Händlers.Bei VISA-Transaktionen sind bis zu 25 Zeichen erlaubt, bei MasterCard nur bis zu 22.

Textfeld2

"cardHolder": { "city": "..."}

ans..30

O

Karteninhaber-Information: Ort (Nicht bei Clearhaus)

Für Banksys: Ort des Händlers. Der Wert wird nach 13 Zeichen abgeschnitten.

CHDesc

–––

ans..22

OC

Nur bei Clearhaus: Text, der auf der Kreditkartenabrechnung angezeigt wird. Nur ASCII druckbare Zeichen von 0x20 bis 0x7E

TID

"safeChargeTransactionId": "..."

ans..30

OC

Nur bei SafeCharge: TransaktionsID der gutzuschreibenden Buchung, falls der Händler eine bestimmte Buchung gutschreiben möchte. Wenn der Parameter nicht angegeben ist, wird die letzte Buchung gutgeschrieben.

Parameter für Gutschrift von Kreditkartenzahlungen

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

es können jederzeit neue Parameter hinzugefügt bzw. die Reihenfolge geändert werden

die Parameter (z.B. MerchantId, RefNr) sollten nicht auf Groß-/Kleinschreibung geprüft werden

KeyRESTFormatCNDDescription

mid

"merchantId": "..."

ans..30

M

HändlerID, die von Computop vergeben wird

PayID

"paymentId": "..."

an32

M

Vom Paygate vergebene ID für die Zahlung; z.B. zur Referenzierung in Batch-Dateien sowie im Capture- oder Credit-Request.

XID

"xId": "..."

an32

M

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

TransID

"transactionId": "..."

ans..64

M

TransaktionsID, die für jede Zahlung eindeutig sein muss

Bitte beachten Sie bei einigen Anbindungen die abweichenden Formate, die bei den spezifischen Parametern angegeben sind.

Status

"status": "OK"

"status": "FAILED"

a..50

M

OK (URLSuccess) oder FAILED (URLFailure)

Description

"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

"code": ...

an8

M

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

Aid

"authorizationId": "..."

n6

OC

Nur bei Card Complete: von Card Complete zurückgegebene Autorisierungs-ID

RefNr

"referenceNumber": "..."

an..25

OC

Eindeutige Referenznummer des Händlers, welche als Auszahlungsreferenz in der entsprechenden Acquirer EPA-Datei angegeben wird. Bitte beachten Sie, ohne die Übergabe einer eigenen Auszahlungsreferenz können Sie die EPA-Transaktionen nicht zuordnen, zusätzlich kann das Computop Settlement File (CTSF) auch nicht zusätzlich angereichert werden.

Nur bei Card Complete, bei Clearhaus (ans..30, nur ASCII druckbare Zeichen von 0x20 bis 0x7E), bei RBI (ns..20, optional), bei Cofidis (n..15, optional).

Es sind ausschließlich ASCII-Zeichen erlaubt. Sonderzeichen wie ("Umlaute", ...) sind nicht erlaubt und müssen ggf. durch ASCII-Zeichen ersetzt werden (z.B. ü → ue, é → e, ...).

Amount

"amountValue": "..."

n..10

O

Nur bei Clearhaus: Betrag in der kleinsten Währungseinheit (z.B. EUR Cent)

Sollte der tatsächliche Betrag vom angefragten Betrag abweichen, wird dieser zurückgegeben.

Nur bei MasaPay: Betrag muss gleich dem ursprünglich autorisierten Betrag sein.

CodeExt

"externalErrorCode": "..."

n5

OC

Nur bei Clearhaus: Nur wenn konfiguriert: externer Fehlercode (nachgelagertes System).

ErrorText

"errorText": "..."

ans..128

OC

Nur bei Clearhaus: Detaillierte Clearhaus Fehlermeldung.

Wird nur bei Status=FAILED zurückgegeben. Nutzung nur in Abstimmung mit Computop Helpdesk möglich.

TransactionID

"clearhausTransactionId": "..."

ans36

OC

Nur bei Clearhaus: Transaktionsnummer von Clearhaus

Ergebnis-Parameter für Gutschrift von Kreditkartenzahlungen

Gutschrift mit Referenz (für Teilbuchungen)

Gutschriften sind mittels Server-to-Server Kommunikation möglich. Das Paygateerlaubt einerseits Gutschriften, die sich auf eine vorher über das Paygate getätigte Buchung beziehen, andererseits können Sie Gutschriften ohne Bezugstransaktion ausführen. Dieses Kapitel beschreibt die Abwicklung von Teil-Gutschriften mit Bezugstransaktion unter Verwendung der XID, welche Sie bei der Buchung/Capture erhalten haben.

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

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

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:

KeyRESTFormatCNDDescription

MerchantID

BasicAuth.Username

ans..30

M

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

PayID

"paymentId": "..."

an32

M

Vom Paygate vergebene ID für die Zahlung; z.B. zur Referenzierung in Batch-Dateien sowie im Capture- oder Credit-Request.

TransID

"transactionId": "..."

ans..64

M

Ihre eigene TransaktionsID, die für jede Zahlung eindeutig sein muss

Amount

"amount": { "value": ...}

n..10

M

Betrag in der kleinsten Währungseinheit (z.B. EUR Cent). Bitte wenden Sie sich an den Computop Helpdesk, wenn Sie Beträge < 100 (kleinste Währungseinheit) buchen möchten.

Currency

"amount": { "currency": "..."}

a3

M

Währung, drei Zeichen DIN / ISO 4217, z.B. EUR, USD, GBP. Hier eine Übersicht: A1 Währungstabelle

MAC

–––

an64

M

Hash Message Authentication Code (HMAC) mit SHA-256-Algorithmus. Details finden Sie hier:

RefNr

"referenceNumber": "..."

ns..30

O

Eindeutige Referenznummer des Händlers, welche als Auszahlungsreferenz in der entsprechenden Acquirer EPA-Datei angegeben wird. Bitte beachten Sie, ohne die Übergabe einer eigenen Auszahlungsreferenz können Sie die EPA-Transaktionen nicht zuordnen, zusätzlich kann das  Computop Settlement File (CTSF) auch nicht zusätzlich angereichert werden.

Es sind ausschließlich ASCII-Zeichen erlaubt. Sonderzeichen wie ("Umlaute", ...) sind nicht erlaubt und müssen ggf. durch ASCII-Zeichen ersetzt werden (z.B. ü → ue, é → e, ...).

ApprovalCode

ans..6

M

von der originalen Autorisierung

XID

"xId": "..."

ans..32

m

XID von der Teilbuchung, die gutgeschrieben werden soll. Diese XID haben Sie bei der Buchung/Capture erhalten.

OrderDesc

"orderDescription": "..."

ans..768

O

Beschreibung der gutgeschriebenen Waren, Einzelpreise, Händlerkommentar usw.

ReqId

"requestId": "..."

ans..32

O

Um Doppelzahlungen (z.B. durch ETM) zu vermeiden, übergeben Sie einen alphanumerischen Wert, der Ihre Transaktion oder Aktion identifiziert und nur einmal vergeben werden darf. Falls die Transaktion oder Aktion mit derselben ReqID erneut eingereicht wird, führt das Computop Paygate keine Zahlung oder weitere Aktion aus, sondern gibt nur den Status der ursprünglichen Transaktion oder Aktion zurück.

Bitte beachten Sie, dass das Computop Paygate für die erste initiale Aktion (Authentifizierung/Autorisierung) einen abgeschlossenen Transaktionsstatus haben muss. Dies gilt nicht für 3-D Secure Authentifizierungen, die durch einem Timeout beendet werden. Der Status 3-D Secure Timeout gilt nicht als abgeschlossener Status, bei dem ReqID-Funktionalität am Paygate nicht greift. Einreichungen mit identischer ReqID auf einen offenen Status werden regulär verarbeitet.

Hinweis: Bitte beachten Sie, dass eine ReqID nur 12 Monate gültig ist, danach wird sie vom Paygate gelöscht.

JSON-Objekt

captureinfo

ans..1024

M

Nötiger Parameter für die Gutschrift eine bestimmten Teilbuchung. Dieser Parameter muss im JSON-Format angelegt werden.

curIdx (M) - Format: n..2 – Eindeutige ID für diese bestimmte Buchung

Anfrage-Parameter für Teil-Gutschrift von Kreditkartenzahlungen

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

es können jederzeit neue Parameter hinzugefügt bzw. die Reihenfolge geändert werden

die Parameter (z.B. MerchantId, RefNr) sollten nicht auf Groß-/Kleinschreibung geprüft werden

KeyRESTFormatCNDDescription

mid

"merchantId": "..."

ans..30

M

HändlerID, die von Computop vergeben wird

PayID

"paymentId": "..."

an32

M

Vom Paygate vergebene ID für die Zahlung; z.B. zur Referenzierung in Batch-Dateien sowie im Capture- oder Credit-Request.

XID

"xId": "..."

an32

M

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

TransID

"transactionId": "..."

ans..64

M

Ihre eigene TransaktionsID, die für jede Zahlung eindeutig sein muss

Status

"status": "OK"

"status": "FAILED"

a..50

M

OK (URLSuccess) oder FAILED (URLFailure)

Description

"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

"code": ...

an8

M

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

RefNr

"referenceNumber": "..."

ns..30

O

Eindeutige Referenznummer des Händlers, welche als Auszahlungsreferenz in der entsprechenden Acquirer EPA-Datei angegeben wird. Bitte beachten Sie, ohne die Übergabe einer eigenen Auszahlungsreferenz können Sie die EPA-Transaktionen nicht zuordnen, zusätzlich kann das  Computop Settlement File (CTSF) auch nicht zusätzlich angereichert werden.

Es sind ausschließlich ASCII-Zeichen erlaubt. Sonderzeichen wie ("Umlaute", ...) sind nicht erlaubt und müssen ggf. durch ASCII-Zeichen ersetzt werden (z.B. ü → ue, é → e, ...).

ApprovalCode

ans..6

M

von der originalen Autorisierung

Ergebnis-Parameter für Teil-Gutschrift von Kreditkartenzahlungen

Gutschrift ohne Referenz

Das Paygate kann für Sie Gutschriften ausführen, die sich nicht auf eine vorherige Buchung beziehen. In diesem Fall muss die Gutschrift als komplett neue Zahlungstransaktion an das Paygateübergeben werden. Um die beschriebene Zusatzfunktion nutzen zu können, nehmen Sie bitte mit dem Computop Helpdesk Kontakt auf.

Hinweis: Bitte beachten Sie, dass Gutschriften ohne Bezug auf eine vorherige Buchung bei Ihrem Acquirer höhere Kosten verursachen. Wenn Sie häufig keinen Bezug auf die Buchung nehmen können, sollten Sie dies mit Ihrem Acquirer abstimmen.

Um eine Gutschrift (Credit) ohne Referenztransaktion über eine Server-zu-Server-Verbindung auszuführen, verwenden Sie bitte folgende URL:

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

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:

KeyFormatCNDDescription

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

Ihre eigene 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 Computop Helpdesk, wenn Sie Beträge < 100 (kleinste Währungseinheit) buchen möchten.

Currency

a3

M

Währung, drei Zeichen DIN / ISO 4217, z.B. EUR, USD, GBP. Hier eine Übersicht: A1 Währungstabelle

MAC

an64

M

Hash Message Authentication Code (HMAC) mit SHA-256-Algorithmus. Details finden Sie hier:

OrderDesc

ans..768

O

Beschreibung der gutgeschriebenen Waren, Einzelpreise, Händlerkommentar usw.

ReqId

ans..32

O

Um Doppelzahlungen (z.B. durch ETM) zu vermeiden, übergeben Sie einen alphanumerischen Wert, der Ihre Transaktion oder Aktion identifiziert und nur einmal vergeben werden darf. Falls die Transaktion oder Aktion mit derselben ReqID erneut eingereicht wird, führt das Computop Paygate keine Zahlung oder weitere Aktion aus, sondern gibt nur den Status der ursprünglichen Transaktion oder Aktion zurück.

Bitte beachten Sie, dass das Computop Paygate für die erste initiale Aktion (Authentifizierung/Autorisierung) einen abgeschlossenen Transaktionsstatus haben muss. Dies gilt nicht für 3-D Secure Authentifizierungen, die durch einem Timeout beendet werden. Der Status 3-D Secure Timeout gilt nicht als abgeschlossener Status, bei dem ReqID-Funktionalität am Paygate nicht greift. Einreichungen mit identischer ReqID auf einen offenen Status werden regulär verarbeitet.

Hinweis: Bitte beachten Sie, dass eine ReqID nur 12 Monate gültig ist, danach wird sie vom Paygate gelöscht.

CCNr

n..16

M

Kreditkartennummer mind. 12stellig numerisch ohne Leerzeichen

CCCVC

n..4

O

Kartenprüfnummer: Die letzten 3 Ziffern auf dem Unterschriftsfeld der Kreditkarte. Bei American Express 4 Ziffern.

CCExpiry

n6

M

Ablaufdatum der Kreditkarte im Format YYYYMM, z.B. 201707

CCBrand

a..22

M

Kreditkartenmarke.

Bitte beachten Sie die Schreibweise gemäß Tabelle der Kreditkartenmarken!

Textfeld1

ans..30

O

Karteninhaber-Information: Name

Textfeld2

ans..30

O

Karteninhaber-Information: Ort

TransactionID

an..150

M

Zusätzliche Referenznummer

Anfrage-Parameter für Gutschrift von Kreditkartenzahlungen ohne Bezug

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

es können jederzeit neue Parameter hinzugefügt bzw. die Reihenfolge geändert werden

die Parameter (z.B. MerchantId, RefNr) sollten nicht auf Groß-/Kleinschreibung geprüft werden

KeyFormatCNDDescription

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 sowie im Capture- oder Credit-Request.

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

Ihre eigene TransaktionsID, die für jede Zahlung eindeutig sein muss

Status

a..50

M

OK (URLSuccess) oder FAILED (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

an8

M

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

Ergebnis-Parameter für Gutschrift von Kreditkartenzahlungen ohne Bezug

Storno

Eine Kreditkartenautorisierung senkt das Kartenlimit des Kunden. Um das Limit wieder freizugeben, kann das Paygate eine Autorisierung stornieren. Verwenden Sie dazu die folgende URL:

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

Hinweis: Die Reverse.aspx macht nicht nur Autorisierungen, sondern IMMER DEN LETZTEN TRANSAKTIONSSCHRITT rückgängig! Falls die letzte Transaktion eine Buchung war, löst die Reverse.aspx z.B. eine Gutschrift aus. Es ist daher größte Vorsicht geboten, und die Nutzung erfolgt auf eigene Gefahr. Wir empfehlen, vor Nutzung der Reverse.aspx den Transaktionsstatus mit der Inquire.aspx prüfen.

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:

KeyRESTFormatCNDDescription

MerchantID

BasicAuth.Username

ans..30

M

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

PayID

"paymentId": "..."

an32

M

Vom Paygate vergebene ID für die Zahlung; z.B. zur Referenzierung in Batch-Dateien sowie im Capture- oder Credit-Request.

TransID

"transactionId": "..."

ans..64

M

TransaktionsID, die für jede Zahlung eindeutig sein muss

Bitte beachten Sie bei einigen Anbindungen die abweichenden Formate, die bei den spezifischen Parametern angegeben sind.

Amount

"amount": { "value": ...}

n..10

M

Betrag in der kleinsten Währungseinheit (z.B. EUR Cent). Bitte wenden Sie sich an den Computop Helpdesk, wenn Sie Beträge < 100 (kleinste Währungseinheit) buchen möchten.

Currency

"amount": { "currency": "..."}

a3

M

Währung, drei Zeichen DIN / ISO 4217, z.B. EUR, USD, GBP. Hier eine Übersicht: A1 Währungstabelle

MAC

–––

an64

M

Hash Message Authentication Code (HMAC) mit SHA-256-Algorithmus. Details finden Sie hier:

RefNr

"referenceNumber": "..."

ans..30

OC

Eindeutige Referenznummer des Händlers, welche als Auszahlungsreferenz in der entsprechenden Acquirer EPA-Datei angegeben wird. Bitte beachten Sie, ohne die Übergabe einer eigenen Auszahlungsreferenz können Sie die EPA-Transaktionen nicht zuordnen, zusätzlich kann das Computop Settlement File (CTSF) auch nicht zusätzlich angereichert werden.

Nur bei Card Complete, bei Clearhaus (nur ASCII druckbare Zeichen von 0x20 bis 0x7E).

Es sind ausschließlich ASCII-Zeichen erlaubt. Sonderzeichen wie ("Umlaute", ...) sind nicht erlaubt und müssen ggf. durch ASCII-Zeichen ersetzt werden (z.B. ü → ue, é → e, ...).

ReqId

"requestId": "..."

ans..32

O

Um Doppelzahlungen (z.B. durch ETM) zu vermeiden, übergeben Sie einen alphanumerischen Wert, der Ihre Transaktion oder Aktion identifiziert und nur einmal vergeben werden darf. Falls die Transaktion oder Aktion mit derselben ReqID erneut eingereicht wird, führt das Computop Paygate keine Zahlung oder weitere Aktion aus, sondern gibt nur den Status der ursprünglichen Transaktion oder Aktion zurück.

Bitte beachten Sie, dass das Computop Paygate für die erste initiale Aktion (Authentifizierung/Autorisierung) einen abgeschlossenen Transaktionsstatus haben muss. Dies gilt nicht für 3-D Secure Authentifizierungen, die durch einem Timeout beendet werden. Der Status 3-D Secure Timeout gilt nicht als abgeschlossener Status, bei dem ReqID-Funktionalität am Paygate nicht greift. Einreichungen mit identischer ReqID auf einen offenen Status werden regulär verarbeitet.

Hinweis: Bitte beachten Sie, dass eine ReqID nur 12 Monate gültig ist, danach wird sie vom Paygate gelöscht.

Parameter für Storno von Kreditkartenzahlungen

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

es können jederzeit neue Parameter hinzugefügt bzw. die Reihenfolge geändert werden

die Parameter (z.B. MerchantId, RefNr) sollten nicht auf Groß-/Kleinschreibung geprüft werden

KeyRESTFormatCNDDescription

mid

"merchantId": "..."

ans..30

M

HändlerID, die von Computop vergeben wird

PayID

"paymentId": "..."

an32

M

Vom Paygate vergebene ID für die Zahlung; z.B. zur Referenzierung in Batch-Dateien sowie im Capture- oder Credit-Request.

XID

"xId": "..."

an32

M

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

TransID

"transactionId": "..."

ans..64

M

TransaktionsID, die für jede Zahlung eindeutig sein muss

Bitte beachten Sie bei einigen Anbindungen die abweichenden Formate, die bei den spezifischen Parametern angegeben sind.

Status

"status": "OK"

"status": "FAILED"

a..50

M

OK (URLSuccess) oder FAILED (URLFailure)

Description

"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

"code": ...

an8

M

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

RefNr

"referenceNumber": "..."

ans..30

OC

Eindeutige Referenznummer des Händlers, welche als Auszahlungsreferenz in der entsprechenden Acquirer EPA-Datei angegeben wird. Bitte beachten Sie, ohne die Übergabe einer eigenen Auszahlungsreferenz können Sie die EPA-Transaktionen nicht zuordnen, zusätzlich kann das Computop Settlement File (CTSF) auch nicht zusätzlich angereichert werden.

Nur bei Card Complete, bei Clearhaus (nur ASCII druckbare Zeichen von 0x20 bis 0x7E).

Es sind ausschließlich ASCII-Zeichen erlaubt. Sonderzeichen wie ("Umlaute", ...) sind nicht erlaubt und müssen ggf. durch ASCII-Zeichen ersetzt werden (z.B. ü → ue, é → e, ...).

AID

"authorizationId": "..."

n6

OC

Nur bei Card Complete: von Card Complete zurückgegebene Autorisierungs-ID

CodeExt

"externalErrorCode": "..."

n5

OC

Nur bei Clearhaus: Nur wenn konfiguriert: externer Fehlercode (nachgelagertes System)

ErrorText

"errorText": "..."

ans.128

OC

Nur bei Clearhaus: Detaillierte Clearhaus Fehlermeldung.

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

TransactionID

"clearhausTransactionId": "..."

ans36

OC

Nur bei Clearhaus: Transaktionsnummer von Clearhaus

Ergebnis-Parameter für Storno von Kreditkartenzahlungen

Storno (einer Teilautorisierung)

Eine Kreditkartenautorisierung senkt das Kartenlimit des Kunden. Das Paygate kann auch nach einer Buchung noch eine offene Teil-Autorisierung stornieren, um das Limit wieder freizugeben.

Verwenden Sie dazu die folgende URL:

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

Hinweis: Die Reverse.aspx macht nicht nur Autorisierungen, sondern IMMER DEN LETZTEN TRANSAKTIONSSCHRITT rückgängig! Falls die letzte Transaktion eine Buchung war, löst die Reverse.aspx z.B. eine Gutschrift aus. Es ist daher größte Vorsicht geboten, und die Nutzung erfolgt auf eigene Gefahr. Wir empfehlen, vor Nutzung der Reverse.aspx den Transaktionsstatus mit der Inquire.aspx prüfen.

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:

KeyRESTFormatCNDDescription

MerchantID

BasicAuth.Username

ans..30

M

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

PayID

"paymentId": "..."

an32

M

Vom Paygate vergebene ID für die Zahlung; z.B. zur Referenzierung in Batch-Dateien sowie im Capture- oder Credit-Request.

TransID

"transactionId": "..."

ans..64

M

Ihre eigene TransaktionsID, die für jede Zahlung eindeutig sein muss

Amount

"amount": { "value": ...}

n..10

M

Betrag in der kleinsten Währungseinheit (z.B. EUR Cent) – der tatsächlich noch autorisierte Betrag, den Sie freigeben möchten

Currency

"amount": { "currency": "..."}

a3

M

Währung, drei Zeichen DIN / ISO 4217, z.B. EUR, USD, GBP. Hier eine Übersicht: A1 Währungstabelle

MAC

–––

an64

M

Hash Message Authentication Code (HMAC) mit SHA-256-Algorithmus. Details finden Sie hier:

RefNr

"referenceNumber": "..."

ns..30

O

Eindeutige Referenznummer des Händlers, welche als Auszahlungsreferenz in der entsprechenden Acquirer EPA-Datei angegeben wird. Bitte beachten Sie, ohne die Übergabe einer eigenen Auszahlungsreferenz können Sie die EPA-Transaktionen nicht zuordnen, zusätzlich kann das  Computop Settlement File (CTSF) auch nicht zusätzlich angereichert werden.

Es sind ausschließlich ASCII-Zeichen erlaubt. Sonderzeichen wie ("Umlaute", ...) sind nicht erlaubt und müssen ggf. durch ASCII-Zeichen ersetzt werden (z.B. ü → ue, é → e, ...).

XID

"xId": "..."

ans..32

M

XID von der Teilautorisierung, die storniert werden soll. Diese XID haben Sie bei der Autorisierung erhalten.

ReqId

"requestId": "..."

ans..32

O

Um Doppelzahlungen (z.B. durch ETM) zu vermeiden, übergeben Sie einen alphanumerischen Wert, der Ihre Transaktion oder Aktion identifiziert und nur einmal vergeben werden darf. Falls die Transaktion oder Aktion mit derselben ReqID erneut eingereicht wird, führt das Computop Paygate keine Zahlung oder weitere Aktion aus, sondern gibt nur den Status der ursprünglichen Transaktion oder Aktion zurück.

Bitte beachten Sie, dass das Computop Paygate für die erste initiale Aktion (Authentifizierung/Autorisierung) einen abgeschlossenen Transaktionsstatus haben muss. Dies gilt nicht für 3-D Secure Authentifizierungen, die durch einem Timeout beendet werden. Der Status 3-D Secure Timeout gilt nicht als abgeschlossener Status, bei dem ReqID-Funktionalität am Paygate nicht greift. Einreichungen mit identischer ReqID auf einen offenen Status werden regulär verarbeitet.

Hinweis: Bitte beachten Sie, dass eine ReqID nur 12 Monate gültig ist, danach wird sie vom Paygate gelöscht.

Parameters for partial authorization reversal of credit card payments

The following table describes the result parameters with which the Computop Paygate responds to your system

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

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

KeyRESTFormatCNDDescription

mid

"merchantId": "..."

ans..30

M

HändlerID, die von Computop vergeben wird

PayID

"paymentId": "..."

an32

M

Vom Paygate vergebene ID für die Zahlung; z.B. zur Referenzierung in Batch-Dateien sowie im Capture- oder Credit-Request.

XID

"xId": "..."

an32

M

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

TransID

"transactionId": "..."

ans..64

M

Ihre eigene TransaktionsID, die für jede Zahlung eindeutig sein muss

Status

"status": "OK"

"status": "FAILED"

a..50

M

OK (URLSuccess) oder FAILED (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

"code": ...

an8

M

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

RefNr

"referenceNumber": "..."

ns..30

O

Eindeutige Referenznummer des Händlers, welche als Auszahlungsreferenz in der entsprechenden Acquirer EPA-Datei angegeben wird. Bitte beachten Sie, ohne die Übergabe einer eigenen Auszahlungsreferenz können Sie die EPA-Transaktionen nicht zuordnen, zusätzlich kann das  Computop Settlement File (CTSF) auch nicht zusätzlich angereichert werden.

Es sind ausschließlich ASCII-Zeichen erlaubt. Sonderzeichen wie ("Umlaute", ...) sind nicht erlaubt und müssen ggf. durch ASCII-Zeichen ersetzt werden (z.B. ü → ue, é → e, ...).

Response parameters for partial authorization reversal of credit card payments

Storno einer Autorisierungsverlängerung

Eine Kreditkartenautorisierung ist nur 7 bis 30 Tage gültig. Um Ihren Zahlungsanspruch bei längeren Lieferzeiten zu erhalten, erlaubt das Paygate die automatische Wiederholung der Autorisierung. Auch bei Ratenzahlung oder Teillieferungen ist die Wiederholung der Autorisierung wichtig, weil bei Teilbuchungen der Restbetrag ungültig wird.

Wenn Sie die Autorisierungsverlängerung nutzen, verlängert das Paygate Ihre Autorisierungen, bis die Zahlung komplett gebucht wurde. Unterdessen bleibt das Kartenlimit des Kunden um den autorisierten Betrag reduziert. Um das Kartenlimit freizugeben, zum Beispiel weil der Auftrag nicht vollständig lieferbar ist, müssen Sie die Autorisierungsverlängerung explizit mit folgender URL stoppen:

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

Hinweis: Mit CancelAuth wird nur die Wiederholung der Autorisierung beendet. Wenn Sie das Kartenlimit des Kunden freigeben wollen, nutzen Sie bitte ein Storno der Autorisierung (siehe oben).

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:

KeyFormatCNDDescription

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 sowie im Capture- oder Credit-Request.

TransID

ans..64

M

ID des Händlers zur Identifizierung des zu stornierenden Zahlungsvorgangs

MAC

an64

M

Hash Message Authentication Code (HMAC) mit SHA-256-Algorithmus. Details finden Sie hier:

Parameter zur Stornierung einer Autorisierungsverlängerung

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

es können jederzeit neue Parameter hinzugefügt bzw. die Reihenfolge geändert werden

die Parameter (z.B. MerchantId, RefNr) sollten nicht auf Groß-/Kleinschreibung geprüft werden

KeyFormatCNDDescription

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 sowie im Capture- oder Credit-Request.

TransID

ans..64

M

Ihre eigene TransaktionsID, die für jede Zahlung eindeutig sein muss

Status

a..50

M

OK (URLSuccess) oder FAILED (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

an8

M

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

Ergebnis-Parameter bei Stornierung einer Autorisierungsverlängerung

Kreditkartenzahlung über stationäre Terminals

Um eine Kreditkartenzahlung über ein stationäres Terminal (POS: Point of Sale) auszuführen, verwenden Sie bitte folgende URL:

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

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:

KeyFormatCNDDescription

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

Ihre eigene 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 Computop Helpdesk, wenn Sie Beträge < 100 (kleinste Währungseinheit) buchen möchten.

Currency

a3

M

Währung, drei Zeichen DIN / ISO 4217, z.B. EUR, USD, GBP. Hier eine Übersicht: A1 Währungstabelle

MAC

an64

M

Hash Message Authentication Code (HMAC) mit SHA-256-Algorithmus. Details finden Sie hier:

RefNr

ns..30

O

Eindeutige Referenznummer des Händlers, welche als Auszahlungsreferenz in der entsprechenden Acquirer EPA-Datei angegeben wird. Bitte beachten Sie, ohne die Übergabe einer eigenen Auszahlungsreferenz können Sie die EPA-Transaktionen nicht zuordnen, zusätzlich kann das Computop Settlement File (CTSF) auch nicht zusätzlich angereichert werden.

Das Format muss vorher mit Computop Helpdesk abgestimmt werden!

CCNr

n..16

M

Kreditkartennummer mind. 12stellig numerisch ohne Leerzeichen

CCCVC

n..4

O

Kartenprüfnummer: Die letzten 3 Ziffern auf dem Unterschriftsfeld der Kreditkarte. Bei American Express 4 Ziffern.

CCExpiry

n6

M

Ablaufdatum der Kreditkarte im Format YYYYMM, z.B. 201707

CCBrand

a..22

M

Kreditkartenmarke.

Bitte beachten Sie die Schreibweise gemäß Tabelle der Kreditkartenmarken!

Track2

ans..80

M

Hexadezimale Daten auf Spur 2 der Kreditkarte

Track3

ans..80

M

Hexadezimale Daten auf Spur 3 der Kreditkarte

OrderDesc

ans..768

M

Beschreibung der gekauften Waren, Einzelpreise etc.

Capture

an..6

OM

Bestimmt Art und Zeitpunkt der Buchung (engl. Capture).

Buchungsart

Beschreibung

AUTO

Buchung sofort nach Autorisierung (Standardwert).

MANUAL

Buchung erfolgt durch den Händler – in der Regel erfolgt die Buchung zum Zeitpunkt der Warenauslieferung bzw. Leistungserbringung.

<Zahl>

Verzögerung in Stunden bis zur Buchung (ganze Zahl; 1 bis 696).

ReqId

ans..32

O

Um Doppelzahlungen (z.B. durch ETM) zu vermeiden, übergeben Sie einen alphanumerischen Wert, der Ihre Transaktion oder Aktion identifiziert und nur einmal vergeben werden darf. Falls die Transaktion oder Aktion mit derselben ReqID erneut eingereicht wird, führt das Computop Paygate keine Zahlung oder weitere Aktion aus, sondern gibt nur den Status der ursprünglichen Transaktion oder Aktion zurück.

Bitte beachten Sie, dass das Computop Paygate für die erste initiale Aktion (Authentifizierung/Autorisierung) einen abgeschlossenen Transaktionsstatus haben muss. Dies gilt nicht für 3-D Secure Authentifizierungen, die durch einem Timeout beendet werden. Der Status 3-D Secure Timeout gilt nicht als abgeschlossener Status, bei dem ReqID-Funktionalität am Paygate nicht greift. Einreichungen mit identischer ReqID auf einen offenen Status werden regulär verarbeitet.

Hinweis: Bitte beachten Sie, dass eine ReqID nur 12 Monate gültig ist, danach wird sie vom Paygate gelöscht.

Parameter für Kreditkartenzahlungen über stationäre Terminals

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

es können jederzeit neue Parameter hinzugefügt bzw. die Reihenfolge geändert werden

die Parameter (z.B. MerchantId, RefNr) sollten nicht auf Groß-/Kleinschreibung geprüft werden

KeyFormatCNDDescription

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 sowie im Capture- oder Credit-Request.

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

Ihre eigene TransaktionsID, die für jede Zahlung eindeutig sein muss

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

an8

M

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

TID

n..20

M

In der Regel neunstellige Terminalnummer

AuthCode

ans..6

M

Autorisierungscode des Acquirers

Status

a..50

M

AUTHORIZED oder FAILED. Nur bei Sale-Transaktionen lautet der Status OK.

Ergebnis-Parameter für Kreditkartenzahlungen über stationäre Terminals

Storno von stationären Kreditkartenzahlungen

Um die Buchung einer Kreditkartenzahlung über ein stationäres Terminal zu stornieren, verwenden Sie bitte folgende URL:

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

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:

KeyFormatCNDDescription

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 sowie im Capture- oder Credit-Request.

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

ID des Händlers zur Identifizierung des zu stornierenden Zahlungsvorgangs

MAC

an64

M

Hash Message Authentication Code (HMAC) mit SHA-256-Algorithmus. Details finden Sie hier:

Parameter zur Stornierung von Kreditkartenzahlungen über stationäre Terminals

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

es können jederzeit neue Parameter hinzugefügt bzw. die Reihenfolge geändert werden

die Parameter (z.B. MerchantId, RefNr) sollten nicht auf Groß-/Kleinschreibung geprüft werden

KeyFormatCNDDescription

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 sowie im Capture- oder Credit-Request.

TransID

ans..64

M

Ihre eigene TransaktionsID, die für jede Zahlung eindeutig sein muss

Status

a..50

M

OK (URLSuccess) oder FAILED (URLFailure)

Code

an8

M

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

Ergebnis-Parameter bei Stornierung von Kreditkartenzahlungen über stationäre Terminals

PayNow

For more information about PayNow, please see chapter Card processing - Capture / Credit / Reversal / PayNow / Batch.

Batch processing via the interface

For more information about batch processing, please see chapter Card processing - Capture / Credit / Reversal / PayNow / Batch.

Paygate

Documentation (EN)

Dokumentation (DE)

Paygate Status