Logo


Info

APACS ist die Abkürzung für "Association for Payment Clearing Services", wird in UK benutzt und ist ein Synonym für das in UK am häufigsten benutzte Kreditkartenprotokoll.

TypZahlungen per Kreditkarte


Einleitung

Acquirer und Verbindung

Computop Paygate unterstützt viele verschiedene Kreditkartenverbindungen zu verschiedenen Acquirern / Prozessoren mit unterschiedlichen Protokollen.

Hier finden Sie eine Übersicht aller unterschiedlichen Kreditkartenschnittstellen: Zahlungen per Kreditkarte.

Zusätzliche Funktionen (z.B. AVS (Address Verification Service), Rückerstattung, 3D Secure, ...) können von der spezifischen Integration und vom Acquirer abhängen.

Integration mit Computop Paygate

Allgemein bieten wir zwei verschiedene Möglichkeiten der Integration an:


Zahlungsseite (payssl.aspx)Direkte Integration (direct.aspx)
Handhabung von Kreditkartennummern (PAN)
  • Wird direkt über die Zahlungsseite abgewickelt.
  • Kreditkartennummer, Ablaufdatum, CVV, ... werden im Zahlungsformular abgefragt
  • Sie kommen nicht mit dern PAN in Kontakt, was die Compliance zu PCI DSS deutlich vereinfacht.
  • Sie erhalten optional eine PseudoCardNumber (PcNr) als Paygate internen Token zur Repräsentation der PAN.
  • Ihr System verarbeitet PAN direkt, sodass Sie "volle Kontrolle" haben.
  • Da Ihr System mit der Kreditkartennummer (PAN) in Kontakt kommt, unterliegt ihr System vollständig dem PCI-DSS-Fokus.
Handhabung von 3-D Secure
  • Sie müssen nur KVP "MsgVer=2.0" hinzufügen, um anzuzeigen, dass Ihr System für 3-D Secure 2.x bereit ist
  • Der Rest (Weiterleitung an die Bank des Ausstellers zur Authentifizierung des Verbrauchers) wird von derPaygate Zahlungsseite abgewickelt.
  • Sie müssen nur KVP "MsgVer=2.0" hinzufügen, um anzuzeigen, dass Ihr System für 3-D Secure 2.x bereit ist
  • Ihr System muss im Falle einer Verbraucherauthentifizierung eine Verbraucherumleitung zur Emittentenbank durchführen
Zusätzliche Daten
  • Zusätzliche Daten können über zusätzliche JSON-Parameter übermittelt werden, z.B.:
    • "credentialOnFile" (für wiederkehrende Zahlungen)
    • Adressdaten (für AVS)
    • 3-D Secure Richtliniendaten
Shop-/System-Integration
  • Die Zahlungsseite kann durch selbst erstellte Vorlagen an Ihre Firmenidentität angepasst werden (Logos, Farben, Positionen, ...).
  • Der Verbraucher wird auf die Zahlungsseite weitergeleitet, um Kreditkartendaten (PAN, Ablaufdatum, CVV, ...) einzugeben.
  • Ihr Shop wird über das Paygate Notify über das Ergebnis der Zahlung im Prozess informiert.
  • Ihr System hat volle Kontrolle über die Eingabefelder für Kreditkartendaten
  • Der Verbraucher wird nicht umgeleitet und Ihr System erhält das Ergebnis des API-Aufrufs über direkte Antwortwerte
Weitere Aktionen
  • Nach dem Auslösen des Zahlungsvorgangs können Sie weitere Aktionen wie Buchung, Gutschrift/Rückerstattung, Stornierungen, ... starten.
  • Diese Aktionen beziehen sich auf einen vorherigen Zahlungsprozess, der durch eine PayID identifiziert wird – was völlig außerhalb vom PCI-DSS-Fokus liegt.
Schlussfolgerung

Empfohlen für Standardintegrationen – aufgrund einfacher Integration und vereinfachter Compliance..

  • Paygate übernimmt die PAN-Handhabung für Sie → vereinfachte PCI DSS Handhabung.
  • Sie können die Paygate Zahlungsseite mittels Vorlagen anpassen.

Empfohlen, wenn Sie die volle Kontrolle benötigen und keine Weiterleitung des Verbrauchers wünschen.

  • Ihr System befindet sich im vollen Geltungsbereich von PCI DSS.

(info) Die nachfolgende Dokumentation gliedert sich daher immer in zwei Abschnitte:

  • Integration über Zahlungsseite (Zahlungsformular)
    • mit allgemeinen Parametern zur Integration des Computop Paygate Zahlungsformulars
    • mit Parametern zur Anpassung des Zahlungsformulars
    • mit spezifischen Parametern für den gewünschten Acquirer / Prozessor
  • Integration über (direkte) Server-2-Server-Integration
    • mit allgemeinen Parametern zur Integration des Computop Paygate Zahlungsformulars
    • mit spezifischen Parametern für den gewünschten Acquirer / Prozessor

Implementierung von 3-D Secure (2.x)

Allgemeine Hinweise zu 3-D Secure

3-D Secure ist ein Verfahren, das den Karteninhaber authentifiziert und sicherstellt, dass der Verbraucher, der die Kreditkartendaten verwendet, wirklich der Karteninhaber ist.

3-D Secure soll den Missbrauch von Kreditkartendaten verhindern – insbesondere im E-Commerce.

3-D Secure 1.x wurde implementiert und fragt den Karteninhaber typischerweise bei jeder Kartennutzung nach einem Passwort.

3-D Secure 2.x wurde implementiert, um:

  • eine starke Kundenauthentifizierung (SCA) zu ermöglichen, indem sie den Karteninhaber mit 2 unabhängigen Faktoren dieser 3 Faktoren anthentifiziert:
    • etwas, das der Karteninhaber weiß, z.B. ein Kennwort
    • etwas, das der Karteninhaber besitzt, z.B. ein Gerät (wie ein Telefon, um einen Token per SMS zu empfangen oder ein anderes OTP, Token-Generator, ...)
    • etwas, das der Karteninhaber ist, z.B. Biometrie (wie Fingerabdruck, Gesichts-ID, ...)
  • eine nahtlose Authentisierung zu ermöglichen, wenn der Verbraucher nicht authentifiziert wird und nicht aufgefordert wird, sich selbst zu authentifizieren.

3-D Secure mit Computop Paygate

Bereiten Sie sich / Ihre Integration auf 3-D Secure 2.x ready vor – hier eine kurze Übersicht mit einigen technischen Details.


3-D Secure 1.x3-D Secure 2.x3-D Secure 2.x Beispiel
Hängt von Ihrer Integration ab: Zahlungsformular ./. Server-2-Server
Zahlungsseite / Zahlungsformular

Ihre vorhandene Integration

Ergänzen Sie einfach den API-Parameter "MsgVer=2.0", der Rest wird automatisch erledigt vomComputop Paygate

Ergänzen Sie den Parameter "MsgVer=2.0" bei Ihrem bestehenden API-Aufruf für den Start des Zahlungsformulars.
URL-VerarbeitungURLFailure und URLSuccess arbeiten mit http-GETURLFailure und URLSuccess arbeiten mit http-POST (wegen der Datenmenge). Seien Sie bereit, beides (GET + POST) zu handhaben.

Server-2-Server Integration

Use KVP:

CCNrKreditkartennummer (PAN)
CCExpiryAblaufdatum der Kreditkarte
CCCVCKreditkartenprüfnummer
CCBrandKreditkartenmarke

Übergeben Sie die Kartendaten mittels "card"-JSON an die API



z.B.:

{
    "securityCode": "569",
    "expiryDate": "202508",
    "cardholderName": "William Thomas",
    "number": "4111111111111111",
    "brand": "VISA"
}

card=ewogICAgInNlY3VyaXR5Q29kZSI6ICI1NjkiLAogICAgImV4cGlyeURhdGUiOiAiMjAyNTA4IiwKICAgICJjYXJkaG9sZGVyTmFtZSI6ICJXaWxsaWFtIFRob21hcyIsCiAgICAibnVtYmVyIjogIjQxMTExMTExMTExMTExMTEiLAogICAgImJyYW5kIjogIlZJU0EiCn0=

Für spezielle Anwendungsfälle finden Sie hier weitere Anwendungsbeispiele: 3DS 2.0 Händler-Anwendungsfälle
Anwendungsfall3-D Secure 1.x3-D Secure 2.x3-D Secure 2.x Beispiel
Wiederkehrende Zahlungen (initial)

Nutzen Sie den Parameter "RTF=I".

Sie erhalten eventuell eine TransactionID als spezifische Transaktions-ID des Karten-Schemes.

Ändern Sie "RTF" zum Parameter "credentialOnFile"-JSON mit "recurring" und "initial=true".

Sie erhalten eventuell eine schemeReferenceID als spezifische Transaktions-ID des Karten-Schemes.

z.B.:

Recurring mit initial=true
{
    "type": {
        "recurring": {
            "recurringFrequency": 30,
            "recurringStartDate": "2021-09-14",
            "recurringExpiryDate": "2022-09-14"
        }
    },
    "initialPayment": true
}

Das JSON muss Base64-codiert sein und dann als Wert für den Parameter credentialOnFile verwendet werden (Bitte beachten Sie, dass Sie den vollständigen Base64-codierten String verwenden einschließlich "=" am Ende.)

credentialOnFile=ewogICAgInR5cGUiOiB7CiAgICAgICAgInJlY3VycmluZyI6IHsKICAgICAgICAgICAgInJlY3VycmluZ0ZyZXF1ZW5jeSI6IDMwLAogICAgICAgICAgICAicmVjdXJyaW5nU3RhcnREYXRlIjogIjIwMjEtMDktMTQiLAogICAgICAgICAgICAicmVjdXJyaW5nRXhwaXJ5RGF0ZSI6ICIyMDIyLTA5LTE0IgogICAgICAgIH0KICAgIH0sCiAgICAiaW5pdGlhbFBheW1lbnQiOiB0cnVlCn0=

Wiederkehrende Zahlungen (nachfolgend)

Nutzen Sie den Parameter "RTF=R"

und übermitteln die TransactionID als spezifische Transaktions-ID des Karten-Schemes

Ändern Sie "RTF" zum Parameter "credentialOnFile"-JSON mit "recurring" und "initial=false"

und übermitteln die schemeReferenceID als spezifische Transaktions-ID des Karten-Schemes

z.B.

Recurring mit initial=false
{
    "type": {
        "recurring": {
            "recurringFrequency": 30,
            "recurringStartDate": "2021-09-14",
            "recurringExpiryDate": "2022-09-14"
        }
    },
    "initialPayment": false
}

Nach der Base64-Codierung:

credentialOnFile=ewogICAgInR5cGUiOiB7CiAgICAgICAgInJlY3VycmluZyI6IHsKICAgICAgICAgICAgInJlY3VycmluZ0ZyZXF1ZW5jeSI6IDMwLAogICAgICAgICAgICAicmVjdXJyaW5nU3RhcnREYXRlIjogIjIwMjEtMDktMTQiLAogICAgICAgICAgICAicmVjdXJyaW5nRXhwaXJ5RGF0ZSI6ICIyMDIyLTA5LTE0IgogICAgICAgIH0KICAgIH0sCiAgICAiaW5pdGlhbFBheW1lbnQiOiBmYWxzZQp9

Vom Kunden ausgelöst (initial)

Nutzen Sie Parameter "RTF=E".

Sie erhalten eventuell eine TransactionID als spezifische Transaktions-ID des Karten-Schemes.

Ändern Sie "RTF" zum Parameter "credentialOnFile"-JSON mit "CIT" und "initial=true".

Sie erhalten eventuell eine schemeReferenceID als spezifische Transaktions-ID des Karten-Schemes.

z.B.

CIT (CustomerInitiated) mit initial=true
{
    "type": {
        "unscheduled": "CIT"
    },
    "initialPayment": true
}

Nach der Base64-Codierung (nochmal: vergessen Sie nicht das "=" am Ende; es muss Bestandteil des Wertes sein):

credentialOnFile=ewogICAgInR5cGUiOiB7CiAgICAgICAgInVuc2NoZWR1bGVkIjogIkNJVCIKICAgIH0sCiAgICAiaW5pdGlhbFBheW1lbnQiOiB0cnVlCn0=

Vom Händler ausgelöst (nachfolgend)

Nutzen Sie Parameter "RTF=M"

und übermitteln die TransactionID als spezifische Transaktions-ID des Karten-Schemes

Ändern Sie "RTF" zum Parameter "credentialOnFile"-JSON mit "MIT" und "initial=false"

und übermitteln die schemeReferenceID als spezifische Transaktions-ID des Karten-Schemes

z.B.

MIT (MerchantInitiated) mit initial=false
{
    "type": {
        "unscheduled": "MIT"
    },
    "initialPayment": false
}

Nach der Base64-Codierung:

credentialOnFile=ewogICAgInR5cGUiOiB7CiAgICAgICAgInVuc2NoZWR1bGVkIjogIk1JVCIKICAgIH0sCiAgICAiaW5pdGlhbFBheW1lbnQiOiBmYWxzZQp9

Adressverifizierungsdienst (AVS)

(abhängig vom Acquirer / Prozessor)

Nutzen Sie die Parameter

  • AddrStreet
  • AddrStreetNr
  • AddrZip
  • AddrCity
  • ....
Ändern Sie die Adressdaten zu address"-JSON

z.B.

Adresse in JSON-Struktur geben
{
    "city": "New York",
    "country": {
        "countryA3": "USA"
    },
    "addressLine1": {
        "street": "Park Avenue",
        "streetNumber": "270"
    },
    "postalCode": "10017-2070",
    "state": "NY"
}

billingAddress=ewogICAgImNpdHkiOiAiTmV3IFlvcmsiLAogICAgImNvdW50cnkiOiB7CiAgICAgICAgImNvdW50cnlBMyI6ICJVU0EiCiAgICB9LAogICAgImFkZHJlc3NMaW5lMSI6IHsKICAgICAgICAic3RyZWV0IjogIlBhcmsgQXZlbnVlIiwKICAgICAgICAic3RyZWV0TnVtYmVyIjogIjI3MCIKICAgIH0sCiAgICAicG9zdGFsQ29kZSI6ICIxMDAxNy0yMDcwIiwKICAgICJzdGF0ZSI6ICJOWSIKfQ==

Antrag für reibungslose Zahlungsabwicklung
  • nicht unterstützt bei 3-D Secure 1.x
  • jede Zahlung wird authentisiert

Stellen Sie zusätzliche Daten bereit als JSON-KVP: JSON-Objekte

z.B.:

Kunden-Challenge explizit anfordern
{
    "challengePreference ": "mandateChallenge"
}

Nach der Base64-Codierung (nochmal: vergessen Sie nicht das "=" am Ende; es muss Bestandteil des Wertes sein):

threeDSPolicy=ewogICAgImNoYWxsZW5nZVByZWZlcmVuY2UgIjogIm1hbmRhdGVDaGFsbGVuZ2UiCn0=






Spezifische Parameter für APACS: AIBMS, Barclaycard, Worldpay

Für die Kreditkartenanbindung APACS 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.

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

Oops, it seems that you need to place a table or a macro generating a table within the Table Filter macro.

The table is being loaded. Please wait for a bit ...


Key

Format

CND

Description

Beschreibung

TransID

an..12

M

TransactionID which should be unique for each payment

TransaktionsID, die für jede Zahlung eindeutig sein muss

RefNr

an..12

O

Merchant’s unique reference number, which serves as payout reference in the acquirer EPA file. Please note, without the own shop reference delivery you cannot read out the EPA transaction and regarding the additional Computop settlement file (CTSF) we cannot add the additional payment data.

Only ASCII characters allowed, special characters ("Umlaute", diacritics) are not allowed and must be replaced by their ASCII-representation (e.g. ü → ue, é → e, ...).

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, ...).

AddrStreet

ans..30

O

Street name of the customer (for AVS)

Straßenname des Kunden (für AVS)

AddrStreetNr

ans..30

O

Street number of the customer (for AVS)

Hausnummer des Kunden (für AVS)

AddrZip

ans..10

O

Postcode of the customer (for AVS)

Postleitzahl des Kunden (für AVS)

AddrCity

ans..20

O

Town/city of the customer (for AVS)

Ort des Kunden (für AVS)

AddrCountryCode

n3

O

Customer's country code according to ISO-3166-1 numeric (3-digits) (for AVS)

Ländercode des Kunden gemäß  ISO-3166-1, numerisch 3-stellig (für AVS)

RTF

a1

O

for repeat payments (subscriptions): I = Initial payment of a new subscription
R = Routine payment (Recurring)

If RTF then there is no AVS

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

Wenn RTF, dann kein AVS

AccVerify

a3

O

AccVerify is available for Barclays only.

If AccVerify=Yes the card will be checked at the acquirer according to the acquirer’s interface description. The merchant has to submit only this parameter, the parameter "Amount" is optional. If  "Amount" is used we replace the amount according to acquirer’s interface description. At payment always Amount=0 is stored.

Allowed value: yes

AccVerify ist nur für Barclays verfügbar.

Ist AccVerify=Yes wird die Karte beim Acquirer entsprechend der Schnittstellenbeschreibung des Acquirers geprüft. Der Händler muss nur diesen Parameter übergeben, der Parameter "Amount" ist optional. Wenn "Amount" verwendet wird, ersetzen wir den Betrag entsprechend der Schnittstellenbeschreibung des Acquirers. Am Payment wird immer Amount=0 gespeichert.

Zulässiger Wert: yes

channel

a4

O

Transaction type (MOTO, ECOM) which supersedes the configured default value.

Transaktionstyp (MOTO, ECOM), überschreibt den als Standard konfigurierten Wert.

ContractIDn..8OFurther contract number between merchant and acquirer, which can be used to override the default VUNr

Weitere Vertragsnummer des Händlers mit dem Acquirer, mit der die Default-VUNr übersteuert werden kann




Conditional additional parameters for Worldpay, MCC 6012

The merchant must have Merchant Category Code MCC 6012 and it must be a VISA transaction inside UK

Bedingte Zusatzparameter für Worldpay, MCC 6012

Der Händler muss Merchant Category Code MCC 6012 haben und es muss eine VISA-Transaktion in UK sein

DateOfBirth

n8

C

Customer’s date of birth

Geburtsdatum des Kunden

LastName

ans..50

C

Last name of the customer

Nachname des Kunden

AccNr

an..22

C

Account number of the customer

Kontonummer des Kunden

AddrZip

ans..10

C

Postcode of the customer

Postleitzahl des Kunden


Zusätzliche Parameter für Kreditkartenzahlungen


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

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

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

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

Oops, it seems that you need to place a table or a macro generating a table within the Table Filter macro.

The table is being loaded. Please wait for a bit ...

Key

Format

CND

Description

Beschreibung

TransID

an..12

M

TransactionID which should be unique for each payment

TransaktionsID, die für jede Zahlung eindeutig sein muss

RefNr

an..12

O

Merchant’s unique reference number, which serves as payout reference in the acquirer EPA file. Please note, without the own shop reference delivery you cannot read out the EPA transaction and regarding the additional Computop settlement file (CTSF) we cannot add the additional payment data.

Only ASCII characters allowed, special characters ("Umlaute", diacritics) are not allowed and must be replaced by their ASCII-representation (e.g. ü → ue, é → e, ...).

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

an6

O

Authorising code of transaction

Autorisierungscode der Transaktion

CodeExt

an2

O

Extended response code from AIBMS or Barclaycard.

Please contact Computop Helpdesk if you want to receive this parameter.

Erweiterter Antwortcode von AIBMS oder Barclaycard.

Bitte wenden Sie sich an den Computop Helpdesk, wenn Sie diesen Parameter empfangen wollen.

ErrorText

ans..80

O

Error text from AIBMS or Barclaycard.

Please contact Computop Helpdesk if you want to receive this parameter.

Fehlertext von AIBMS oder Barclaycard.

Bitte wenden Sie sich an den Computop Helpdesk, wenn Sie diesen Parameter empfangen wollen.

cvcmatch

a1

M

Result of CVC check (M = exact match, N = no match, U = card not checked)

Ergebnis der CVC-Prüfung (M = exakte Übereinstimmung, N = keine Übereinstimmung, U = Karte nicht geprüft)

match

a1

O

Result of address check, see A3 AVS match parameters

Ergebnis der Adressprüfung, siehe A3 AVS Match-Parameter

Zusätzliche Ergebnis-Parameter für Kreditkartenzahlungen


Kreditkarten - Kreditkartenformular

Bei Kartenzahlungen über bei Computop gehostete Formulare wird die Komplexität von 3-D Secure vollständig bei der Implementierung beim Händler entfernt.

Aus Sicht des Händlers unterscheidet sich die Sequenz nicht zwischen Zahlungen, die mit 3DS authentisiert sind, sowie nicht mit 3DS authentisierten Zahlungen, welche die Berücksichtigung zusätzlicher Parameter in Aufruf und Antwort erfordern.

Hinweis zum Cookie-/Session Handling

Bitte beachten Sie, dass einige Browser beim Rücksprung zu Ihrem Shop erforderliche Cookies blockieren könnten. Hier finden Sie weitere Informationen und verschiedene Lösungsansätze.


Vereinfachtes Sequenz-Diagramm




Zahlungsanfrage

Zum Abruf eines Computop-Formulars für Kartenzahlungen übermitteln Sie bitte folgende Parameter über einen HTTP POST Aufruf an https://www.computop-paygate.com/payssl.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:

Oops, it seems that you need to place a table or a macro generating a table within the Table Filter macro.

The table is being loaded. Please wait for a bit ...

KeyRESTFormatCNDDescriptionBeschreibung

MerchantID

BasicAuth.Username

ans..30

M

MerchantID, assigned by Computop. Additionally this parameter has to be passed in plain language too.

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

KeyRESTFormatCNDDescriptionBeschreibung
msgver---

ans..5

M

Computop Paygate Message version. Valid values:

ValueDescription
2.0With 3-D Secure 2.x a lot of additional data were required (e.g. browser-information, billing/shipping-address, account-info, ...) to improve authentication processing. To handle these information the JSON-objects have been put in place to handle such data. To indicate that these data are used the MsgVer has been implemented.

Computop Paygate Message-Version. Zulässige Werte:

WertBeschreibung
2.0Mit 3-D Secure 2.x wurde eine Vielzahl zusätzlicher Daten (Browser-Information, Rechnungs-/Versand-Adresse, ...) erforderlich, um den Authentifizierungs-Prozess zu optimieren. Um diese Informationen zu handhaben, wurden die JSON-Objekte eingeführt. Der Parameter MsgVer zeigt an, dass diese Daten verwendet werden.

KeyRESTFormatCNDDescriptionBeschreibung
ReqId"requestId": "..."

ans..32

O

To avoid double payments or actions (e.g. by ETM), enter an alphanumeric value which identifies your transaction and may be assigned only once. If the transaction or action is submitted again with the same ReqID, Computop Paygate will not carry out the payment or new action, but will just return the status of the original transaction or action.

Please note that the Computop Paygate must have a finalized transaction status for the first initial action (authentication/authorisation). This does not apply to 3-D Secure authentications that are terminated by a timeout. The 3-D Secure Timeout status does not count as a completed status in which the ReqID functionality on Paygate does not take effect. Submissions with identical ReqID for an open status will be processed regularly.

Notice: Please note that a ReqID is only valid for 12 month, then it gets deleted at the Paygate.

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.

KeyRESTFormatCNDDescriptionBeschreibung
TransID"transactionId": "..."

ans..64

MTransactionID provided by you which should be unique for each paymentIhre eigene TransaktionsID, die für jede Zahlung eindeutig sein muss

KeyRESTFormatCNDDescriptionBeschreibung
RefNr"referenceNumber": "..."
O

Merchant’s unique reference number, which serves as payout reference in the acquirer EPA file. Please note, without the own shop reference delivery you cannot read out the EPA transaction and regarding the additional  Computop settlement file (CTSF) we cannot add the additional payment data.

(info) Details on supported format can be found below in payment specific section.

Only ASCII characters allowed, special characters ("Umlaute", diacritics) are not allowed and must be replaced by their ASCII-representation (e.g. ü → ue, é → e, ...).

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.

(info) Informationen zum unterstützten Format finden Sie weiter unten in der zahlartspezifischen Beschreibung.

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, ...).

KeyRESTFormatCNDDescriptionBeschreibung

MAC

---

an64

M
Hash Message Authentication Code (HMAC) with SHA-256 algorithm. Details can be found here:
Hash Message Authentication Code (HMAC) mit SHA-256-Algorithmus. Details finden Sie hier:

KeyRESTFormatCNDDescriptionBeschreibung
Amount"amount": { "value": ...}

n..10

M

Amount in the smallest currency unit (e.g. EUR Cent). Please contact the Computop Helpdesk, if you want to capture amounts <100 (smallest currency unit).

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.

KeyRESTFormatCNDDescriptionBeschreibung
Currency"amount": { "currency": "..."}

a3

M

Currency, three digits DIN / ISO 4217, e.g. EUR, USD, GBP. Please find an overview here: A1 Currency table

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

KeyRESTFormatCNDDescriptionBeschreibung
Capture

"capture": {"auto": "Yes"}

"capture": {"manual": "Yes"}

"capture": ...


an..6

OM

Determines the type and time of capture.

Capture ModeDescription
AUTOCapturing immediately after authorisation (default value).
MANUALCapturing made by the merchant. Capture is normally initiated at time of delivery.
<Number>Delay in hours until the capture (whole number; 1 to 696).

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

BuchungsartBeschreibung
AUTOBuchung sofort nach Autorisierung (Standardwert).
MANUALBuchung erfolgt durch den Händler - in der Regel die Buchung zum Zeitpunkt der Warenauslieferung bzw. Leistungserbringung.
<Zahl>Verzögerung in Stunden bis zur Buchung (ganze Zahl; 1 bis 696).

KeyRESTFormatCNDDescriptionBeschreibung
PayTypes"payment": {"cardForm": { "payTypes": "..." }}ans..256O

With this parameter you can override the accepted schemes, i.e. you can decide within this parameter separated by pipe which of the available credit card schemes are displayed.

The template must support this function like for example the "Cards_v1".

Example: PayTypes=VISA|MasterCard

Mit diesem Parameter können Sie die akzeptierten Schemes übersteuern, d.h. Sie können innerhalb dieses Parameters durch Pipe getrennt entscheiden, welche der verfügbaren Kreditkartenschemes angezeigt werden.

Das Template muss diese Funktion unterstützen wie zum Beispiel das "Cards_v1".

Beispiel: PayTypes=VISA|MasterCard

billingDescriptor

"billing": {"addressInfo": { "descriptor": "..." }}

ans..22

O

A descriptor to be printed on a card holder’s statement. Please also refer to the additional comments made elsewhere for more information about rules and regulations.Eine Bezeichnung, die auf dem Kontoauszug des Karteninhbaers gedruckt wird. Beachten Sie bitte auch die zusätzliche Hinweise an anderer Stelle für weitere Informationen über Regeln und Vorschriften.

OrderDesc

"order": {"description": "..."}

ans..768

O

Description of purchased goods, unit prices etc.Beschreibung der gekauften Waren, Einzelpreise etc.

AccVerify

"payment": {"card": { "accountVerification": "..." }}

a3

O

Indicator to request an account verification (aka zero value authorization). If an account verification is requested the submitted amount will be optional and ignored for the actual payment transaction (e.g. authorization).

Values accepted

  • Yes

Indikator für Anforderung einer Kontoverifizierung (alias Nullwert-Authorisierung). Bei einer angeforderten Kontoverifizierung ist der übermittelte Betrag optional und wird für die tatsächliche Zahlungstransaktion ignoriert (z.B. Autorisierung).

Zulässiger Wert:

  • Yes

threeDSPolicy

"payment": {"card": { "threeDsPolicy": JSON }}

JSON

O

Object specifying authentication policies and exemption handling strategiesObjekt, das Authentisierungs-Richtlinien und Vorgaben für die Ausnahmenbehandlung festlegt

priorAuthenticationInfo

"payment": {"card": { "priorAuthenticationInfo": JSON }}

JSON

O

Prior Transaction Authentication Information contains optional information about a 3DS cardholder authentication that occurred prior to the current transactionDas Objekt Prior Transaction Authentication Information enthält optionale Informationen über eine Authentisierung eines 3DS-Karteninhabers, die vor der aktuellen Transaktion erfolgt ist

accountInfo

"accountInfo": JSON

JSON

O

The account information contains optional information about the customer account with the merchantDas Objekt Kontoinformationen enthält optionale Informationen über das Kundenkonto beim Händler

billToCustomer

"billing": JSON

JSON

C

The customer that is getting billed for the goods and / or services. Required for EMV 3DS unless market or regional mandate restricts sending this information.

Der Kunde, dem die Waren und / oder Dienstleistungen in Rechnung gestellt werden. Für EMV 3DS erforderlich, sofern nicht Markt- oder Regionalmandate die Übermittlung dieser Informationen beschränken.

shipToCustomer

"shipping": JSON

JSON

C

The customer that the goods and / or services are sent to. Required if different from billToCustomer.Der Kunde, an den die Waren und / oder Dienstleistungen gesendet werden. Erforderlich, falls von billToCustomer abweichend.

billingAddress

"billing": {"addressInfo": JSON}

JSON

C

Billing address. Required for EMV 3DS (if available) unless market or regional mandate restricts sending this information.Rechnungsadresse. For EMV 3DS erforderlich (falls verfügbar), sofern nicht Markt- oder Regionalmandate die Übermittlung dieser Informationen beschränken.

shippingAddress

"shipping": {"addressInfo": JSON}

JSON

C

Shipping address. If different from billingAddress, required for EMV 3DS (if available) unless market or regional mandate restricts sending this information.Lieferadresse. Falls von billingAddress abweichend; für EMV 3DS erforderlich (falls verfügbar), sofern nicht Markt- oder Regionalmandate die Übermittlung dieser Informationen beschränken.

credentialOnFile

"credentialOnFile": JSON

JSON

C

Object specifying type and series of transactions using payment account credentials (e.g. account number or payment token) that is stored by a merchant to process future purchases for a customer. Required if applicable.Objekt, das Art und Reihe von Transaktionen mittels Zahlungskonto-Zugangsdaten festlegt (z.B. Kontonummer oder Zahlungs-Token), die bei einem Händler für die Verarbeitung zukünftiger Einkäufe für einen Kunden gespeichert sind. Erforderlich, falls zutreffend.

merchantRiskIndicator

"riskIndicator": JSON

JSON

O

The Merchant Risk Indicator contains optional information about the specific purchase by the customer.

If no shippingAddress is present it is strongly recommended to populate the shippingAddressIndicator property with an appropriate value such as shipToBillingAddress, digitalGoods or noShipment.

Der Händler-Risikoindikator enthält optionale Informationen über den bestimmten Einkauf des Kunden.

Falls shippingAddress nicht vorhanden ist, ist es dringend empfohlen, das Merkmal shippingAddressIndicator mit einem entsprechenden Wert wie shipToBillingAddress, digitalGoods oder noShipment auszufüllen.

subMerchantPF"subMerchantPaymentFacilitator": JSONJSONO

Object specifying SubMerchant (Payment Facilitator) details.

(info) Only supported by SafeCharge

Objekt, das die Details des SubMerchant (Payment Facilitator) angibt.

(info) Wird ausschließlich von SafeCharge unterstützt.

KeyRESTFormatCNDDescriptionBeschreibung
URLSuccess"urls": {"success": "..."}

ans..256

M

Complete URL which calls up Paygate if payment has been successful. The URL may be called up only via port 443. This URL may not contain parameters: In order to exchange values between Paygate and shop, please use the parameter UserData.

(info) Common notes:

  • We recommend to use parameter "response=encrypt" to get an encrypted response by Paygate
  • However, fraudster may just copy the encrypted DATA-element which are sent to URLFailure and send the DATA to URLSuccess. Therefore ensure to check the "code"-value which indicates success/failure of the action. Only a result of "code=00000000" should be considered successful.

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

(info) Allgemeine Hinweise:

  • Wir empfehlen, den Parameter "response=encrypt" zu verwenden, um eine verschlüsselte Antwort von Paygate zu erhalten
  • Betrüger könnten das verschlüsselte DATA-Element kopieren, welches an URLFailure gesendet wurde, und betrügerisch dasselbe DATA an URLSuccess senden. Überprüfen Sie daher unbedingt den "code"-Wert des DATA-Elements. Nur eine Antwort mit "code=00000000" sollte als erfolgreich angesehen werden.

KeyRESTFormatCNDDescriptionBeschreibung
URLFailure"urls": {"failure": "..."}

ans..256

M

Complete URL which calls up Paygate if payment has been unsuccessful. The URL may be called up only via port 443. This URL may not contain parameters: In order to exchange values between Paygate and shop, please use the parameter UserData.

(info) Common notes:

  • We recommend to use parameter "response=encrypt" to get an encrypted response by Paygate
  • However, fraudster may just copy the encrypted DATA-element which are sent to URLFailure and send the DATA to URLSuccess/URLNotify. Therefore ensure to check the "code"-value which indicates success/failure of the action. Only a result of "code=00000000" should be considered successful.

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

(info) Allgemeine Hinweise:

  • Wir empfehlen, den Parameter "response=encrypt" zu verwenden, um eine verschlüsselte Antwort von Paygate zu erhalten
  • Betrüger könnten das verschlüsselte DATA-Element kopieren, welches an URLFailure gesendet wurde, und betrügerisch dasselbe DATA an URLSuccess/URLNotify senden. Überprüfen Sie daher unbedingt den "code"-Wert des DATA-Elements. Nur eine Antwort mit "code=00000000" sollte als erfolgreich angesehen werden.

KeyRESTFormatCNDDescriptionBeschreibung
URLBack"urls": {"cancel": "..."}

ans..256

O

Complete URL which Paygate calls in case that Cancel is clicked by the customer.

The parameter "URLBack" can be sent

  • either as plain parameter (unencrypted) (compatibility mode)
  • or be part of encrypted payment request parameters (preferred mode)

In order to exchange values between Paygate and shop you may use something like this:

URLBack=https://your.shop.com/back.php?param1%3Dvalue1%26param2%3Dvalue3%26status%3Dcancelled 

When user cancels payment this URL is called exactly like this and you may use URL Decode to extract parameter and values.

Vollständige URL, die das Paygate aufruft, wenn der Kunde auf Abbruch klickt.

Der Parameter "URLBack" kann

  • sowohl unverschlüsselt ans Paygate übermittelt werden (Kompabilitätsmodus)
  • als auch in den verschlüsselten Übergabeparametern (bevorzugte Variante)

Wenn Sie Parameter/Werte in der URLBack übergeben möchten, so können Sie folgende Methode verwenden:

URLBack=https://your.shop.com/back.php?param1%3Dvalue1%26param2%3Dvalue3%26status%3Dcancelled 

Wenn der Kunde auf Abbruch klickt, so wird die URL genauso aufgerufen, so dass Sie URL Decode verwenden können, um Parameter und Werte zu extrahieren.

KeyRESTFormatCNDDescriptionBeschreibung
Response

---

a7

O

Status response sent by Paygate to URLSuccess and URLFailure, should be encrypted. For this purpose, transmit Response=encrypt parameter.

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

KeyRESTFormatCNDDescriptionBeschreibung
URLNotify"urls": {"notify": "..."}

ans..256

M

Complete URL which Paygate calls up in order to notify the shop about the payment result. The URL may be called up only via port 443. It may not contain parameters: Use the UserData parameter instead.

(info) Common notes:

  • Fraudster may just copy the encrypted DATA-element which are sent to URLFailure and send the DATA to URLSuccess/URLNotify. Therefore ensure to check the "code"-value which indicates success/failure of the action. Only a result of "code=00000000" should be considered successful.

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

(info) Allgemeine Hinweise:

  • Betrüger könnten das verschlüsselte DATA-Element kopieren, welches an URLFailure gesendet wurde, und betrügerisch dasselbe DATA an URLSuccess/URLNotify senden. Überprüfen Sie daher unbedingt den "code"-Wert des DATA-Elements. Nur eine Antwort mit "code=00000000" sollte als erfolgreich angesehen werden.

KeyRESTFormatCNDDescriptionBeschreibung
UserData"metadata[userData]": "..."

ans..1024

O

If specified at request, Paygate forwards the parameter with the payment result to the shop.

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

KeyRESTFormatCNDDescriptionBeschreibung
Plain"metadata[plain]": "..."

ans..50

O

A single value to be set by the merchant to return some information unencrypted in response/notify, e.g. the MID. 

"Plain"-parameter is part of encrypted "Data" in Computop Paygate and therefore protected against manipulation. 

Ein einzelner Wert, der von Ihnen gesetzt werden kann, um Informationen wieder unverschlüsselt in der Antwort bzw. im Notify zurückzugeben, z.B. die MID.

Da der "Plain"-Parameter Teil des verschlüsselten "Data" im Computop Paygate ist, ist dieser vor Manipulationen geschützt. 

KeyRESTFormatCND

Description

Beschreibung
Custom"metadata": "..."

ans..1024

O

"Custom"-parameter is added to the request data before encryption and is part of encrypted "Data" in Computop Paygate request. By this they are protected against manipulation by a consumer. 

The Custom-value is added to the Computop Paygate response in plain text and the "|" is replaced by a "&". By this you can put a single value into Custom-parameter and get multiple key-value-pairs back in response for your own purpose. 

Please find a samples here: Custom

Der "Custom"-Parameter wird vor der Verschlüsselung an den Aufruf angehängt und ist Teil des verschlüsselten "Data" im Computop Paygate Aufruf. Dadurch ist der Wert gegen Manipulation geschützt. 

Der Custom-Wert wird dann in Klartext an die Computop Paygate-Antwort angehängt und dabei wird "|" durch "&" ersetzt. Dadurch können Sie einen Custom-Wert übergeben und bekommen mehrere Key-Value-Paare zu Ihrer eigenen Verwendung in der Antwort zurück.

Hier finden Sie ein Beispiel: Custom

KeyRESTFormatCNDDescriptionBeschreibung
expirationTime"expirationTime": "..."

ans..19

O

timestamp for the end time of the transaction processing, specified in UTC.

Format: YYYY-MM-ddTHH:mm:ss

Zeitstempel für den Endzeitpunkt der Transaktionsverarbeitung, Angabe in UTC.

Format: YYYY-MM-ddTHH:mm:ss

Computop Paygate gibt in der Antwort ein HTML-Dokument zurück, welches das angeforderte Kartenzahlungsformular darstellt. Das Formular kann in die Checkout-Seite des Händlers integriert oder als selbständige Seite verwendet werden, auf die der Karteninhaber weitergeleitet wird.

Die Authentisierung des Karteninhabers sowie die Zahlungsautorisierung erfolgen, nachdem der Karteninhaber aller erforderlichen Kartendetails eingegeben und das Formular an das Computop Paygate übermittelt hat.

Hinweis: Falls Sie ein eigenes Zahlungsformular verwenden (Corporate Payment Page), achten Sie darauf, dass der Name des Karteninhabers auf dem Formular enthalten ist. Der Name das Karteninhabers wird auf den Paygate API-Parameter "CreditCardHolder" abgebildet. Das Feld Cardholder name darf keine Sonderzeichen enthalten und muss eine Mindestlänge von 2 Zeichen und eine Maximallänge von 45 Zeichen haben.

Wenn die Zahlung abgeschlossen ist, sendet das Computop Paygate eine Benachrichtigung an den Server des Händlers (d.h. URLNotify) und leitet den Browser an URLSuccess beziehungsweise URLFailure weiter.


Die per Blowfish verschlüsselten Parameter laut folgender Tabelle werden per HTTP POST an URLNotify und URLSuccess/URLFailure übertragen.

Hinweis: Bitte beachten Sie, dass der Aufruf der URLSuccess oder URLFailure bei einem Fallback zu 3-D Secure 1.0 mit GET stattfindet. Ihre Systeme sollten daher Parameter sowohl per GET als auch per POST entgegennehmen können.

(info)  Das Kreditkarten-Formular kann mittels eines eigenen Templates sehr stark angepasst werden. 

Details hierzu finden Sie hier: Corporate PayPage und Templates

HTTP POST an URLSuccess / URLFailure / URLNotify

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

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

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

Oops, it seems that you need to place a table or a macro generating a table within the Table Filter macro.

The table is being loaded. Please wait for a bit ...

KeyFormatCNDDescriptionBeschreibung

mid

ans..30

M

MerchantID, assigned by Computop

HändlerID, die von Computop vergeben wird

KeyFormatCNDDescriptionBeschreibung
msgver

ans..5

M

Computop Paygate Message version. Valid values:

ValueDescription
2.0With 3-D Secure 2.x a lot of additional data were required (e.g. browser-information, billing/shipping-address, account-info, ...) to improve authentication processing. To handle these information the JSON-objects have been put in place to handle such data. To indicate that these data are used the MsgVer has been implemented.

Computop Paygate Message-Version. Zulässige Werte:

WertBeschreibung
2.0Mit 3-D Secure 2.x wurde eine Vielzahl zusätzlicher Daten (Browser-Information, Rechnungs-/Versand-Adresse, ...) erforderlich, um den Authentifizierungs-Prozess zu optimieren. Um diese Informationen zu handhaben, wurden die JSON-Objekte eingeführt. Der Parameter MsgVer zeigt an, dass diese Daten verwendet werden.

KeyFormatCNDDescriptionBeschreibung
PayID

an32

M

ID assigned by Paygate for the payment, e.g. for referencing in batch files as well as for capture or credit request.

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

KeyFormatCNDDescriptionBeschreibung
XID

an32

M

ID for all single transactions (authorisation, capture, credit note) for one payment assigned by Paygate

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

KeyFormatCNDDescriptionBeschreibung
TransID

ans..64

MTransactionID provided by you which should be unique for each paymentIhre eigene TransaktionsID, die für jede Zahlung eindeutig sein muss

KeyFormatCNDDescriptionBeschreibung
schemeReferenceID

ans..64

C

Card scheme specific transaction ID required for subsequent credential-on-file payments, delayed authorizations and resubmissions.

Mandatory: CredentialOnFile – initial false – unscheduled MIT / recurring

schemeReferenceID is returned for 3DS2-payments. In case of fallback to 3DS1 you will also need to check for TransactionId.

The schemeReferenceID is a unique identifier generated by the card brands and as a rule Computop merchants can continue to use the SchemeReferenceIDs for subscription plans that were created while using another PSP environment / Paygate MerchantID / Acquirer ContractID / Acquirer.

Spezifische Transaktions-ID des Kartenschemas, die für nachfolgende Zahlungen mit gespeicherten Zugangsdaten, verzögerte Autorisierungen und Wiedereinreichungen erforderlich ist.

Pflicht: CredentialOnFile – initial false – unschedule MIT / recurring

schemeReferenceID wird bei 3DS2-Zahlungsvorgängen zurückgegeben. Bei einem Fallback auf 3DS1 prüfen Sie bitte zusätzlich auf TransactionId.

Die SchemeReferenceID ist eine eindeutige Kennung, die von den Kartenmarken generiert wird. In der Regel können Computop-Händler die SchemeReferenceIDs für Abonnements übergreifend verwenden, welche unter Verwendung eines anderen PSP / separater Paygate-MerchantID / separater Acquirer ContractID / Acquirer erstellt wurden.

KeyFormatCNDDescriptionBeschreibung
refnr
OReference number taken from requestReferenznummer vom Request
Statusa..20M

Status of the transaction.

Values accepted:

  • Authorized
  • OK (Sale)
  • FAILED

In case of Authentication-only the Status will be either OK or FAILED.

Status der Transaction.

Zulässige Werte:

  • Authorized
  • OK (Sale)
  • FAILED

Im Fall von nur-Authentisierung ist der Status entweder OK oder FAILED.

KeyFormatCNDDescriptionBeschreibung
Description

ans..1024

M
Further details in the event that payment is rejected. Please do not use the Description but the Code parameter for the transaction status analysis!
Nähere Beschreibung bei Ablehnung der Zahlung. Bitte nutzen Sie nicht den Parameter Description, sondern Code für die Auswertung des Transaktionsstatus!

KeyFormatCNDDescriptionBeschreibung
Code

an8

M

Error code according to Paygate Response Codes (A4 Error codes)

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

KeyFormatCNDDescriptionBeschreibung

card

JSON

M

Card data

Kartendaten

ipinfo

JSON

O

Object containing IP information

Objekt mit IP-Informationen

threedsdata

JSON

M

Authentication data

Authentisierungsdaten

resultsresponse

JSON

C

In case the authentication process included a cardholder challenge additional information about the challenge result will be provided.

Falls der Authentisierungsprozess eine Challenge des Karteninhabers enthalten hat, werden zusätzliche Informationen über das Ergebnis der Challenge bereitgestellt
externalPaymentDataJSONOOptional additional data from acquirer/issuer/3rd party for authorization.Optionale Daten des Acquirers/Issuers/externen Dienstleisters für eine Autorisierung
TimeStampDate/TimeO

Timestamp of this action if activated by Computop Helpdesk, e.g. 30.05.2023 08:47:57 or 30.05.2023 10:03:01.633

Zeitstempel dieser Aktion, wenn vom Computop Helpdesk aktiviert, z.B. 30.05.2023 08:47:57 oder 30.05.2023 10:03:01.633

CardHolderans..50O

Card holder name if activated by Computop Helpdesk, e.g. John Doe

Name des Karteninhabers, wenn vom Computop Helpdesk aktiviert, z.B. Max Mustermann

binn..6O

BIN of credit card if activated by Computop Helpdesk, e.g. 40001

BIN der Kreditkarte, wenn vom Computop Helpdesk aktiviert, z.B. 40001

maskedpanan..19O

Masked number of credit card if activated by Computop Helpdesk, e.g. 400001XXXXXX8323

Maskierte Kreditkartennummer, wenn vom Computop Helpdesk aktiviert, z.B. 400001XXXXXX8323

cardinfoJSONO

JSON containing data of credit card type and issuer if activated by Computop Helpdesk, e.g. {"BIN":"400001","Brand":"VISA","Product":"","Source":"CREDIT","Type":"","Country":{"A3":"USA","N3":"840"},"Issuer":""}

JSON-Struktur, welche Informationen zur Kreditkarte bzw. dem Issuer enthält, wenn vom Computop Helpdesk aktiviert, z.B. {"BIN":"400001","Brand":"VISA","Product":"","Source":"CREDIT","Type":"","Country":{"A3":"USA","N3":"840"},"Issuer":""}

CCBrandan..20OBrand / card scheme of credit card, e.g. VISABrand / Karten-Scheme der Kreditkarte, z.B. VISA

KeyFormatCNDDescriptionBeschreibung
PCNr

n16

O

Pseudo Card Number: Random number generated by Computop Paygate which represents a genuine credit card number. The pseudo card number (PCN) starts with 0 and the last 3 digits correspond to those of the real card number. The PCN can be used like a genuine card number for authorisation, capture and credits.

PCNr is a response value from Computop Paygate and is sent as CCNr in Request or part of card-JSON

Pseudo Card Number: Vom Computop Paygate generierte Zufallszahl, die eine reale Kreditkartennummer repräsentiert. Die Pseudokartennummer (PKN) beginnt mit 0, und die letzten 3 Stellen entsprechen denen der realen Kartennummer. Die PKN kann wie eine Kreditkartennummer für Autorisierung, Buchung und Gutschriften verwendet werden.

PCNr ist ein Antwortwert von Computop Paygate und kann ebenfalls als CCNr im Request oder als Teil von card-JSON verwendet werden.

KeyFormatCNDDescriptionBeschreibung
CCExpiry

n6

OC

Optional in combination with PCNr: Expiry date of the credit card in the format YYYYMM (202207).

In Verbindung mit PCNr: Ablaufdatum der Kreditkarte im Format YYYYMM (202207).

KeyFormatCNDDescriptionBeschreibung
Plain

ans..50

O

A single value to be set by the merchant to return some information unencrypted in response/notify, e.g. the MID. 

"Plain"-parameter is part of encrypted "Data" in Computop Paygate and therefore protected against manipulation. 

Ein einzelner Wert, der von Ihnen gesetzt werden kann, um Informationen wieder unverschlüsselt in der Antwort bzw. im Notify zurückzugeben, z.B. die MID.

Da der "Plain"-Parameter Teil des verschlüsselten "Data" im Computop Paygate ist, ist dieser vor Manipulationen geschützt. 

KeyFormatCND

Description

Beschreibung
Custom

ans..1024

O

"Custom"-parameter is added to the request data before encryption and is part of encrypted "Data" in Computop Paygate request. By this they are protected against manipulation by a consumer. 

The Custom-value is added to the Computop Paygate response in plain text and the "|" is replaced by a "&". By this you can put a single value into Custom-parameter and get multiple key-value-pairs back in response for your own purpose. 

Please find a samples here: Custom

Der "Custom"-Parameter wird vor der Verschlüsselung an den Aufruf angehängt und ist Teil des verschlüsselten "Data" im Computop Paygate Aufruf. Dadurch ist der Wert gegen Manipulation geschützt. 

Der Custom-Wert wird dann in Klartext an die Computop Paygate-Antwort angehängt und dabei wird "|" durch "&" ersetzt. Dadurch können Sie einen Custom-Wert übergeben und bekommen mehrere Key-Value-Paare zu Ihrer eigenen Verwendung in der Antwort zurück.

Hier finden Sie ein Beispiel: Custom

KeyFormatCNDDescriptionBeschreibung
UserData

ans..1024

O

If specified at request, Paygate forwards the parameter with the payment result to the shop.

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

KeyFormatCNDDescriptionBeschreibung

MAC

an64

M
Hash Message Authentication Code (HMAC) with SHA-256 algorithm. Details can be found here:
Hash Message Authentication Code (HMAC) mit SHA-256-Algorithmus. Details finden Sie hier:


Kreditkartenzahlung mit separater Autorisierung

Für Kreditkartenzahlungen kann im Prozessablauf die ORDER von der anschließenden Autorisierung und nachfolgenden Schritten getrennt werden. Dazu wird die SSL-Kreditkartenzahlung zunächst per Formular oder Server-zu-Server-Anbindung wie in den voranstehenden Kapiteln dargestellt mit einem zusätzlichen Parameter initialisiert und dann über die Schnittstelle authorize.aspx per Server-zu-Server-Verbindung autorisiert. Zur Initialisierung rufen Sie folgende URL auf:


Bei Server-zu-Server-Anbindung rufen Sie folgende URL auf:


Die folgende Tabelle beschreibt die verschlüsselten Übergabeparameter:

Oops, it seems that you need to place a table or a macro generating a table within the Table Filter macro.

The table is being loaded. Please wait for a bit ...

Key

REST

Format

CND

Description

Beschreibung

TxType

"payment": {"card": { "transactionType": "..." }}

ans..20

M

Submit “Order” to initialize a payment which later will be authorised via interface authorize.aspx. Please note that in combination with the used 3-D Secure method a separate setting is necessary. Please contact directly Computop Helpdesk.

Übergeben Sie „Order“, um eine Zahlung zu initialisieren und diese später über die Schnittstelle authorize.aspx zu autorisieren. Bitte beachten Sie, dass in Verbindung mit dem genutzten 3-D Secure-Verfahren eine separate Einstellung notwendig ist. Bitte wenden Sie sich hierzu direkt an Computop Helpdesk.

Zusatzparameter für Kreditkartenzahlung mit separater Autorisierung


Um eine zuvor mit TxType=Order initialisierte SSL-Kreditkartenzahlung zu autorisieren, rufen Sie folgende URL auf:


Hinweis: Bitte beachten Sie, dass bei einer initialen Order keine KPN/CVC/CVV-Prüfung erfolgen kann. Für die folgende Reservierungsanfrage kann diese ID auch nicht weitergegeben 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:

Oops, it seems that you need to place a table or a macro generating a table within the Table Filter macro.

The table is being loaded. Please wait for a bit ...

KeyRESTFormatCNDDescriptionBeschreibung

MerchantID

BasicAuth.Username

ans..30

M

MerchantID, assigned by Computop. Additionally this parameter has to be passed in plain language too.

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

KeyRESTFormatCNDDescriptionBeschreibung
PayID"paymentId": "..."

an32

M

ID assigned by Paygate for the payment, e.g. for referencing in batch files as well as for capture or credit request.

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

KeyRESTFormatCNDDescriptionBeschreibung
TransID"transactionId": "..."

ans..64

MTransactionID provided by you which should be unique for each paymentIhre eigene TransaktionsID, die für jede Zahlung eindeutig sein muss

KeyRESTFormatCNDDescriptionBeschreibung
Amount"amount": { "value": ...}

n..10

M

Amount in the smallest currency unit (e.g. EUR Cent). Please contact the Computop Helpdesk, if you want to capture amounts <100 (smallest currency unit).

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.

KeyRESTFormatCNDDescriptionBeschreibung
Currency"amount": { "currency": "..."}

a3

M

Currency, three digits DIN / ISO 4217, e.g. EUR, USD, GBP. Please find an overview here: A1 Currency table

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

Key

REST

Format

CND

Description

Beschreibung

OrderDesc

"order": {"description": "..."}

ans..768

O

Description of purchased goods, unit prices etc.

Beschreibung der gekauften Waren, Einzelpreise etc.

KeyRESTFormatCNDDescriptionBeschreibung

MAC

---

an64

M
Hash Message Authentication Code (HMAC) with SHA-256 algorithm. Details can be found here:
Hash Message Authentication Code (HMAC) mit SHA-256-Algorithmus. Details finden Sie hier:

KeyRESTFormatCNDDescriptionBeschreibung
Capture

"capture": {"auto": "Yes"}

"capture": {"manual": "Yes"}

"capture": ...


an..6

OM

Determines the type and time of capture.

Capture ModeDescription
AUTOCapturing immediately after authorisation (default value).
MANUALCapturing made by the merchant. Capture is normally initiated at time of delivery.
<Number>Delay in hours until the capture (whole number; 1 to 696).

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

BuchungsartBeschreibung
AUTOBuchung sofort nach Autorisierung (Standardwert).
MANUALBuchung erfolgt durch den Händler - in der Regel die Buchung zum Zeitpunkt der Warenauslieferung bzw. Leistungserbringung.
<Zahl>Verzögerung in Stunden bis zur Buchung (ganze Zahl; 1 bis 696).

Parameter für Kreditkartenzahlungen über authorize.aspx


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

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

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

Oops, it seems that you need to place a table or a macro generating a table within the Table Filter macro.

The table is being loaded. Please wait for a bit ...

KeyRESTFormatCNDDescriptionBeschreibung

mid

"merchantId": "..."

ans..30

M

MerchantID, assigned by Computop

HändlerID, die von Computop vergeben wird

KeyRESTFormatCNDDescriptionBeschreibung
PayID"paymentId": "..."

an32

M

ID assigned by Paygate for the payment, e.g. for referencing in batch files as well as for capture or credit request.

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

KeyRESTFormatCNDDescriptionBeschreibung
XID"xId": "..."

an32

M

ID for all single transactions (authorisation, capture, credit note) for one payment assigned by Paygate

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

KeyRESTFormatCNDDescriptionBeschreibung
TransID"transactionId": "..."

ans..64

MTransactionID provided by you which should be unique for each paymentIhre eigene TransaktionsID, die für jede Zahlung eindeutig sein muss

KeyRESTFormatCNDDescriptionBeschreibung
Status

"status": "OK"

"status": "FAILED"

a..50

M

OK (URLSuccess) or FAILED (URLFailure)

OK (URLSuccess) oder FAILED (URLFailure)

KeyRESTFormatCNDDescriptionBeschreibung
Description"description": "..."

ans..1024

M
Further details in the event that payment is rejected. Please do not use the Description but the Code parameter for the transaction status analysis!
Nähere Beschreibung bei Ablehnung der Zahlung. Bitte nutzen Sie nicht den Parameter Description, sondern Code für die Auswertung des Transaktionsstatus!

KeyRESTFormatCNDDescriptionBeschreibung
Code"code": ...

an8

M

Error code according to Paygate Response Codes (A4 Error codes)

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

KeyRESTFormatCNDDescriptionBeschreibung
RefNr"referenceNumber": "..."
O

Merchant’s unique reference number, which serves as payout reference in the acquirer EPA file. Please note, without the own shop reference delivery you cannot read out the EPA transaction and regarding the additional  Computop settlement file (CTSF) we cannot add the additional payment data.

(info) Details on supported format can be found below in payment specific section.

Only ASCII characters allowed, special characters ("Umlaute", diacritics) are not allowed and must be replaced by their ASCII-representation (e.g. ü → ue, é → e, ...).

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.

(info) Informationen zum unterstützten Format finden Sie weiter unten in der zahlartspezifischen Beschreibung.

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, ...).

Ergebnis-Parameter für Kreditkartenzahlungen über authorize.aspx


Erweitertes Sequenz-Diagramm


Kreditkarten - Server-2-Server Integration

Eine 3DS 2.0 Zahlungssequenz kann aus den folgenden verschiedenen Aktivitäten bestehen:

  • Versionierung
    • Anfrage von ACS- und DS-Protokol-Version(en), die mit dem Kartenkontenbereich korrespondieren sowie einer optionalen 3DS Method URL
  • 3DS Methode

    • Verbindet den Browser des Karteninhabers mit dem ACS des Issuers, um zusätzliche Browserdaten zu erhalten

  • Authentisierung

    • Übermittlung der Authentisierungs-Anfrage an den ACS des Issuers

  • Challenge

    • Challenge des Karteninhabers, falls angeordnet

  • Autorisierung

    • Autorisierung der authentisierten Transaktion beim Acquirer

Server-2-Server Sequenzdiagramm

Server-2-Server Sequence Diagram

Beachten Sie bitte, dass die Kommunikation zwischen Client und Access Control Server (ACS) über iFrames implementiert ist. Daher kommen die Antworten in einem HTML-Subdokument an und Sie können entsprechende Event-Listener in Ihrem Root-Dokument einrichten.

Alternativ könnten Sie alleinig auf die asynchronen Benachrichtigungen an ihr Backend vertrauen. In jenen Fällen müssen Sie eventuell Methoden wie Long Polling, SSE oder Websockets zum Update des Clients in Betracht ziehen.


Initiierung der Zahlung

Die anfängliche Anfrage an das Computop Paygate ist unabhängig vom zugrundeliegenden 3DS-Protokoll gleich.


Um eine Server-zu-Server 3-D Secure Kartenzahlungssequenz zu starten, senden Sie bitte folgende Schlüssel-Wert-Paare an https://www.computop-paygate.com/direct.aspx.


Aufruf-Elemente

Hinweis: Bei einer vom Händler initiierten, wiederkehrenden Zahlung sind die JSON-Objekte (außer credentialOnFile und card), die URLNotify und die TermURL keine Pflichtparameter, da kein 3D Secure und auch keine Risikobewertung durch die kartenausgebende Bank stattfindet und das Ergebnis der Zahlungsanfrage direkt in der Response mitgeteilt wird.

Oops, it seems that you need to place a table or a macro generating a table within the Table Filter macro.

The table is being loaded. Please wait for a bit ...

KeyRESTFormatCNDDescriptionBeschreibung

MerchantID

BasicAuth.Username

ans..30

M

MerchantID, assigned by Computop. Additionally this parameter has to be passed in plain language too.

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

KeyRESTFormatCNDDescriptionBeschreibung
msgver---

ans..5

M

Computop Paygate Message version. Valid values:

ValueDescription
2.0With 3-D Secure 2.x a lot of additional data were required (e.g. browser-information, billing/shipping-address, account-info, ...) to improve authentication processing. To handle these information the JSON-objects have been put in place to handle such data. To indicate that these data are used the MsgVer has been implemented.

Computop Paygate Message-Version. Zulässige Werte:

WertBeschreibung
2.0Mit 3-D Secure 2.x wurde eine Vielzahl zusätzlicher Daten (Browser-Information, Rechnungs-/Versand-Adresse, ...) erforderlich, um den Authentifizierungs-Prozess zu optimieren. Um diese Informationen zu handhaben, wurden die JSON-Objekte eingeführt. Der Parameter MsgVer zeigt an, dass diese Daten verwendet werden.

KeyRESTFormatCNDDescriptionBeschreibung
TransID"transactionId": "..."

ans..64

MTransactionID provided by you which should be unique for each paymentIhre eigene TransaktionsID, die für jede Zahlung eindeutig sein muss

KeyRESTFormatCNDDescriptionBeschreibung
ReqId"requestId": "..."

ans..32

O

To avoid double payments or actions (e.g. by ETM), enter an alphanumeric value which identifies your transaction and may be assigned only once. If the transaction or action is submitted again with the same ReqID, Computop Paygate will not carry out the payment or new action, but will just return the status of the original transaction or action.

Please note that the Computop Paygate must have a finalized transaction status for the first initial action (authentication/authorisation). This does not apply to 3-D Secure authentications that are terminated by a timeout. The 3-D Secure Timeout status does not count as a completed status in which the ReqID functionality on Paygate does not take effect. Submissions with identical ReqID for an open status will be processed regularly.

Notice: Please note that a ReqID is only valid for 12 month, then it gets deleted at the Paygate.

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.

KeyRESTFormatCNDDescriptionBeschreibung
RefNr"referenceNumber": "..."
O

Merchant’s unique reference number, which serves as payout reference in the acquirer EPA file. Please note, without the own shop reference delivery you cannot read out the EPA transaction and regarding the additional  Computop settlement file (CTSF) we cannot add the additional payment data.

(info) Details on supported format can be found below in payment specific section.

Only ASCII characters allowed, special characters ("Umlaute", diacritics) are not allowed and must be replaced by their ASCII-representation (e.g. ü → ue, é → e, ...).

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.

(info) Informationen zum unterstützten Format finden Sie weiter unten in der zahlartspezifischen Beschreibung.

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, ...).

KeyRESTFormatCNDDescriptionBeschreibung
schemeReferenceID"payment": {"card": { "schemeReferenceId": "..." }}

ans..64

C

Card scheme specific transaction ID required for subsequent credential-on-file payments, delayed authorizations and resubmissions.

Mandatory: CredentialOnFile – initial false – unscheduled MIT / recurring

schemeReferenceID is returned for 3DS2-payments. In case of fallback to 3DS1 you will also need to check for TransactionId.

The schemeReferenceID is a unique identifier generated by the card brands and as a rule Computop merchants can continue to use the SchemeReferenceIDs for subscription plans that were created while using another PSP environment / Paygate MerchantID / Acquirer ContractID / Acquirer.

Spezifische Transaktions-ID des Kartenschemas, die für nachfolgende Zahlungen mit gespeicherten Zugangsdaten, verzögerte Autorisierungen und Wiedereinreichungen erforderlich ist.

Pflicht: CredentialOnFile – initial false – unschedule MIT / recurring

schemeReferenceID wird bei 3DS2-Zahlungsvorgängen zurückgegeben. Bei einem Fallback auf 3DS1 prüfen Sie bitte zusätzlich auf TransactionId.

Die SchemeReferenceID ist eine eindeutige Kennung, die von den Kartenmarken generiert wird. In der Regel können Computop-Händler die SchemeReferenceIDs für Abonnements übergreifend verwenden, welche unter Verwendung eines anderen PSP / separater Paygate-MerchantID / separater Acquirer ContractID / Acquirer erstellt wurden.

KeyRESTFormatCNDDescriptionBeschreibung
industrySpecificTxType"payment": {"card": { "industrySpecificTransactionType": "..." }}

ans..20

C

This parameter is required whenever an industry specific transaction is processed according to the card brands MIT (Merchant Initiated Transactions) Framework, i.e.: specific use cases like described below.

(info) Only supported with Omnipay and GICC.

(info) Supported with CB2A for Reauthorization, only.

Values accepted:

ValueDescription

Resubmission

A merchant performs a re-submission in cases where it requested an authorization, but received a decline due to insufficient funds; however, the goods or services were already delivered to the cardholder.

Merchants in such scenarios can resubmit the request to recover outstanding debt from cardholders.

Reauthorization

A merchant initiates a re-authorization when the completion or fulfillment of the original order or service extends beyond the authorization validity limit set by Visa.

There are two common re-authorization scenarios:

Split or delayed shipments at eCommerce retailers. A split shipment occurs when not all the goods ordered are available for shipment at the time of purchase. If the fulfillment of the goods takes place after the authorization

validity limit set by Visa, eCommerce merchants perform a separate authorization to ensure that consumer funds are available.

Extended stay hotels, car rentals, and cruise lines. A re-authorization is used for stays, voyages, and/or rentals that extend beyond the authorization validity period set by Visa.

DelayedCharges

Delayed charges are performed to process a supplemental account charge after original services have been rendered and respective payment has been processed.

NoShow

Cardholders can use their Visa cards to make a guaranteed reservation with certain merchant segments. A guaranteed reservation ensures that the reservation will be honored and allows a merchant to perform a No Show transaction to charge the cardholder a penalty according to the merchant’s cancellation policy.
Note: For merchants that accept token-based payment credentials to guarantee a reservation, it is necessary to perform a CIT (Account Verification Service) at the time of reservation to be able perform a No Show transaction later.

Note: It is always submitted in conjunction with the "schemeReferenceID" parameter. Please contact Computop Helpdesk for the supported Acquirer and card brands.

Dieser Parameter ist erforderlich, wenn eine branchenspezifische Transaktion entsprechend dem Kartenmarken MIT-Framework (Merchant Initiated Transactions) verarbeitet wird. Der Parameter wird nur für bestimmte Use Cases verwendet, die unten beschrieben sind.

(info) Wird nur von Omnipay und GICC unterstützt. 

(info) CB2A unterstützt nur den Wert Reauthorization

Zulässige Werte:

WertBeschreibung

Resubmission

Ein Händler führt eine erneute Einreichung durch, wenn er eine Autorisierung angefordert hat, diese aber aufgrund unzureichender Mittel abgelehnt wurde; die Waren oder Dienstleistungen wurden jedoch bereits an den Karteninhaber geliefert.

In solchen Szenarien können Händler den Antrag auf Beitreibung ausstehender Forderungen von Karteninhabern erneut einreichen.

Reauthorization

Ein Händler leitet eine erneute Autorisierung ein, wenn Abschluss oder Erfüllung der ursprünglichen Bestellung oder Dienstleistung die von Visa festgelegte Gültigkeitsdauer der Autorisierung überschreitet.

Es gibt zwei gängige Szenarien für die erneute Autorisierung:

 Geteilte oder verzögerte Lieferung be E-Commerce-Händlern. Eine Teillieferung liegt vor, wenn zum Zeitpunkt des Kaufs nicht alle bestellten Waren versandbereit sind. Erfolgt die Lieferung der Ware nach der von Visa festgelegten Gültigkeitsdauer der Autorisierung, führen E-Commerce-Händler eine separate Autorisierung durch, um sicherzustellen, dass Kundengelder verfügbar sind.

 Verlängerte Hotelaufenthaltens, Autovermietungen und Keuzfahrten. Eine erneute Autorisierung wird für Aufenthalte, Reisen und/oder Anmietungen verwendet, die über die von Visa festgelegte Gültigkeitsdauer der Autorisierung hinausgehen.

DelayedCharges

Verzögerte Gebühren dienen dazu, um eine zusätzliche Kontogebühr zu verarbeiten, nachdem die ursprünglichen Dienstleistungen erbracht und die entsprechende Zahlung verarbeitet wurde.

NoShow

Karteninhaber können mit ihren Visa-Karten eine garantierte Reservierung bei bestimmten Händlersegmenten vornehmen. Eine garantierte Reservierung stellt sicher, dass die Reservierung berücksichtigt wird und ermöglicht es einem Händler, eine No-Show-Transaktion durchzuführen, um dem Karteninhaber eine Strafe gemäß den Stornierungsbedingungen des Händlers zu berechnen.
Hinweis: Für Händler, die tokenbasierte Zahlungsinformationen akzeptieren, um eine Reservierung zu garantieren, ist es zum Zeitpunkt der Reservierung erforderlich, einen CIT (Kontoverifizierungsservice) durchzuführen, um später eine No-Show-Transaktion durchführen zu können.

Hinweis: Das wird immer zusammen mit dem Parameter "schemeReferenceID" übermittelt. Bezüglich unterstützer Acquirer und Kartenmarken wenden Sie sich bitte an den Computop Helpdesk.

KeyRESTFormatCNDDescriptionBeschreibung
Amount"amount": { "value": ...}

n..10

M

Amount in the smallest currency unit (e.g. EUR Cent). Please contact the Computop Helpdesk, if you want to capture amounts <100 (smallest currency unit).

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.

KeyRESTFormatCNDDescriptionBeschreibung
Currency"amount": { "currency": "..."}

a3

M

Currency, three digits DIN / ISO 4217, e.g. EUR, USD, GBP. Please find an overview here: A1 Currency table

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

KeyRESTFormatCNDDescriptionBeschreibung
card"payment": {"card": JSON}JSONMCard dataKartendaten

KeyRESTFormatCNDDescriptionBeschreibung
Capture

"capture": {"auto": "Yes"}

"capture": {"manual": "Yes"}

"capture": ...


an..6

OM

Determines the type and time of capture.

Capture ModeDescription
AUTOCapturing immediately after authorisation (default value).
MANUALCapturing made by the merchant. Capture is normally initiated at time of delivery.
<Number>Delay in hours until the capture (whole number; 1 to 696).

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

BuchungsartBeschreibung
AUTOBuchung sofort nach Autorisierung (Standardwert).
MANUALBuchung erfolgt durch den Händler - in der Regel die Buchung zum Zeitpunkt der Warenauslieferung bzw. Leistungserbringung.
<Zahl>Verzögerung in Stunden bis zur Buchung (ganze Zahl; 1 bis 696).

KeyRESTFormatCNDDescriptionBeschreibung
billingDescriptor"billing": {"addressInfo": { "descriptor": "..." }}ans..22OA descriptor to be printed on a card holder’s statement. Please also refer to the additional comments made elsewhere for more information about rules and regulations.Ein auf dem Kontoauszug des Karteninhabers zu druckender Beschreiber. Beachten Sie bitte auch die andernorts gemachten zusätzlichen Hinweise für weitere Informationen über Regeln und Vorschriften.
OrderDesc"order": {"description": "..."}ans..768OOrder descriptionBeschreibung der Bestellung
AccVerify"payment": {"card": { "accountVerification": "..." }}a3O

Indicator to request an account verification (aka zero value authorization). If an account verification is requested the submitted amount will be optional and ignored for the actual payment transaction (e.g. authorization).

Values accepted:

  • Yes

Indikator zur Anforderung einer Konto-Verifizierung (alias Nullwert-Autorisierung). Wenn eine Konto-Verifizierung angefordert wird, ist der übermittelte Betrag optional und wird für die tatsächliche Zahlungstransaktion (d.h. Autorisierung) ignoriert.

Zulässige Werte:

  • Yes

threeDSPolicy

"payment": {"card": { "threeDsPolicy": JSON }}

JSON

O

Object specifying authentication policies and exemption handling strategies

Objekt, dass die Authentisierungs-Richtlinien und Strategien zur Behandlung von Ausnahmen angibt

threeDSData

"payment": {"card": { "threeDSData": JSON }}

JSON

C

Object detailing authentication data in case authentication was performed through a third party or by the merchant

Objekt mit Details der Authentisierungsdaten, falls die Authentisierung durch Dritte oder durch den Händler durchgeführt wurde

priorAuthenticationInfo

"payment": {"card": { "priorAuthenticationInfo": JSON }}

JSON

O

Prior Transaction Authentication Information contains optional information about a 3-D Secure cardholder authentication that occurred prior to the current transaction

Das Objekt Prior Transaction Authentication Information enthält optionale Informationen über eine 3-D Secure-Authentisierung eines Karteninhabers, die vor der aktuellen Transaktion erfolgt ist

browserInfo

"browserInfo": JSON

JSON

C

Accurate browser information are needed to deliver an optimized user experience. Required for 3-D Secure 2.0 transactions.

Exakte Browserinformationen sind nötig, um eine optimierte Nutzererfahrung zu liefern. Erforderlich für 3-D Secure 2.0 Transaktionen.

accountInfo

"accountInfo": JSON

JSON

O

The account information contains optional information about the customer account with the merchant. Optional for 3-D Secure 2.0 transactions.

Die Kontoinformationen enthalten optionale Informationen über das Kundenkonto beim Händler

billToCustomer

"billing": JSON

JSON

C

The customer that is getting billed for the goods and / or services. Required unless market or regional mandate restricts sending this information.

Der Kunde, dem die Waren und / oder Dienstleistungen in Rechnung gestellt werden. Erforderlich, sofern nicht Markt- oder regionale Mandate das Senden dieser Informationen beschränken.

shipToCustomer

"shipping": JSON

JSON

C

The customer that the goods and / or services are sent to. Required (if available and different from billToCustomer) unless market or regional mandate restricts sending this information.

Der Kunde, an den die Waren und / oder Dienstleistungen gesendet werden. Erforderlich (falls verfügbar und von billToCustomer abweichend), sofern nicht Markt- oder regionale Mandate das Senden dieser Informationen beschränken.

billingAddress

"billing": {"addressInfo": JSON}

JSON

C

Billing address. Required for 3-D Secure 2.0 (if available) unless market or regional mandate restricts sending this information.

Rechnungsadresse. Erforderlich für 3-D Secure 2.0 (falls verfügbar), sofern nicht Markt- oder regionale Mandate das Senden dieser Informationen beschränken.

shippingAddress

"shipping": {"addressInfo": JSON}

JSON

C

Shipping address. If different from billingAddress, required for 3-D Secure 2.0 (if available) unless market or regional mandate restricts sending this information.

Lieferadresse. Falls abweichend von billingAddress, erforderlich für 3-D Secure 2.0 (falls verfügbar), sofern nicht Markt- oder regionale Mandate das Senden dieser Informationen beschränken.

credentialOnFile

"credentialOnFile": JSON

JSON

C

Object specifying type and series of transactions using payment account credentials (e.g. account number or payment token) that is stored by a merchant to process future purchases for a customer. Required if applicable.

Objekt, dass Art und Reihe der Transaktionen angibt, die unter Verwendung von beim Händler hinterlegten Zahlungsdaten (z.B. Kontonummer oder Zahlungs-Token) zur Verarbeitung künftiger Käufe eines Kunden erfolgen. Erforderlich, falls zutreffend.

merchantRiskIndicator

"riskIndicator": JSON

JSON

O

The Merchant Risk Indicator contains optional information about the specific purchase by the customer

Der Händler-Risikoindikator enthält optionale Informationen über den bestimmten Einkauf des Kunden
subMerchantPF"subMerchantPaymentFacilitator": JSONJSONO

Object specifying SubMerchant (Payment Facilitator) details

(info) Only supported by SafeCharge

Objekt, das die Details des SubMerchant (Payment Facilitator) angibt

(info) Wird ausschließlich von SafeCharge unterstützt.

KeyRESTFormatCNDDescriptionBeschreibung
TermURL"payment": {"threeDSLegacy": { "termUrl": "..." }}

ans..256

C

Only for 3-D Secure: URL of the shop which has been selected by the Access Control Server (ACS) of the bank to transmit the result of the authentication. The bank transmits the parameters PayID, TransID and MerchantID via GET and the PAResponse parameter via POST to the TermURL.

In case of a merchant initiated recurring transaction the JSON objects (besides credentialOnFile and card), the URLNotify and TermURL are not mandatory parameters, because no 3-D Secure and no risk evaluation is done by the card issuing bank and the payment result is directly returned within the response.

Nur bei 3-D Secure: URL des Shops, die vom Access Control Server (ACS) der Bank aufgerufen wird, um das Ergebnis der Authentisierung zu übermitteln. Dabei übergibt die Bank per GET die Parameter PayID, TransID, MerchantID und per POST den Parameter PAResponse an die TermURL.

Im Falle einer vom Händler initiierten wiederkehrenden Transaktion sind die JSON-Objekte (außer credentialOnFile und card), URLNotify und TermURL keine obligatorischen Parameter, da kein 3-D Secure und keine Risikobewertung durch die kartenausgebende Bank erfolgt und das Zahlungsergebnis direkt erfolgt innerhalb der Antwort zurückgegeben.

KeyRESTFormatCNDDescriptionBeschreibung
URLNotify"urls": {"notify": "..."}

ans..256

C

Complete URL which Paygate calls up in order to notify the shop about the payment result. The URL may be called up only via port 443. It may not contain parameters: Use the UserData parameter instead.

In case of a merchant initiated recurring transaction the JSON objects (besides credentialOnFile and card), the URLNotify and TermURL are not mandatory parameters, because no 3-D Secure and no risk evaluation is done by the card issuing bank and the payment result is directly returned within the response.

(info) Common notes:

  • Fraudster may just copy the encrypted DATA-element which are sent to URLFailure and send the DATA to URLSuccess/URLNotify. Therefore ensure to check the "code"-value which indicates success/failure of the action. Only a result of "code=00000000" should be considered successful.

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

Im Falle einer vom Händler initiierten wiederkehrenden Transaktion sind die JSON-Objekte (außer credentialOnFile und card), URLNotify und TermURL keine obligatorischen Parameter, da kein 3-D Secure und keine Risikobewertung durch die kartenausgebende Bank erfolgt und das Zahlungsergebnis direkt erfolgt innerhalb der Antwort zurückgegeben.

(info) Allgemeine Hinweise:

  • Betrüger könnten das verschlüsselte DATA-Element kopieren, welches an URLFailure gesendet wurde, und betrügerisch dasselbe DATA an URLSuccess/URLNotify senden. Überprüfen Sie daher unbedingt den "code"-Wert des DATA-Elements. Nur eine Antwort mit "code=00000000" sollte als erfolgreich angesehen werden.

KeyRESTFormatCNDDescriptionBeschreibung
UserData"metadata[userData]": "..."

ans..1024

O

If specified at request, Paygate forwards the parameter with the payment result to the shop.

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

KeyRESTFormatCNDDescriptionBeschreibung

MAC

---

an64

M
Hash Message Authentication Code (HMAC) with SHA-256 algorithm. Details can be found here:
Hash Message Authentication Code (HMAC) mit SHA-256-Algorithmus. Details finden Sie hier:

Antwort-Elemente

Oops, it seems that you need to place a table or a macro generating a table within the Table Filter macro.

The table is being loaded. Please wait for a bit ...

KeyFormatCNDDescriptionBeschreibung

mid

ans..30

M

MerchantID, assigned by Computop

HändlerID, die von Computop vergeben wird

KeyFormatCNDDescriptionBeschreibung
PayID

an32

M

ID assigned by Paygate for the payment, e.g. for referencing in batch files as well as for capture or credit request.

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

KeyFormatCNDDescriptionBeschreibung
XID

an32

M

ID for all single transactions (authorisation, capture, credit note) for one payment assigned by Paygate

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

KeyFormatCNDDescriptionBeschreibung
TransID

ans..64

MTransactionID provided by you which should be unique for each paymentIhre eigene TransaktionsID, die für jede Zahlung eindeutig sein muss

KeyFormatCNDDescriptionBeschreibung
refnr
OReference number as given in requestReferenznummer wie im Request angegeben

Status

a..20

M

Status of the transaction.

Values accepted:

  • AUTHENTICATION_REQUEST

  • PENDING
  • FAILED

Status der Transaktion.

Zulässige Werte:

  • AUTHENTICATION_REQUEST

  • PENDING
  • FAILED

KeyFormatCNDDescriptionBeschreibung
Description

ans..1024

M
Further details in the event that payment is rejected. Please do not use the Description but the Code parameter for the transaction status analysis!
Nähere Beschreibung bei Ablehnung der Zahlung. Bitte nutzen Sie nicht den Parameter Description, sondern Code für die Auswertung des Transaktionsstatus!

KeyFormatCNDDescriptionBeschreibung
Code

an8

M

Error code according to Paygate Response Codes (A4 Error codes)

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

KeyFormatCNDDescriptionBeschreibung
UserData

ans..1024

O

If specified at request, Paygate forwards the parameter with the payment result to the shop.

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

KeyFormatCNDDescriptionBeschreibung
cardJSONMCard dataKartendaten

versioningdata

JSON

M

The Card Range Data data element contains information that indicates the most recent EMV 3-D Secure version supported by the ACS that hosts that card range. It also may optionally contain the ACS URL for the 3-D Secure Method if supported by the ACS and the DS Start and End Protocol Versions which support the card range.

Das Datenelement Card Range Data enthält Informationen, welche die jüngste vom ACS, der den Kartenbereich hostet, unterstützte EMV 3-D Secure-Version angeben. Es kann optional auch die ACS URL für die 3-D Secure Methode enthalten, falls vom ACS unterstützt, sowie die DS Start- und End-Protokoll-Versionen, die den Kartenbereich unterstützen.

threeDSLegacy

JSON

C

Object containing the data elements required to construct the Payer Authentication request in case of a fallback to 3-D Secure 1.0.

Objekt, dass die erforderlichen Datenelemente für die Konstruktion der Anfrage zur Zahler-Authentisierung im Falle eines Fallbacks auf 3-D Secure 1.0 enthält.

versioningData

Das Objekt versioningData gibt die EMV 3DS Protokoll-Versionen (d.h. 2.1.0 oder höher) an, die vom Access Control Server des Issuers unterstützt werden.

Wenn die entsprechenden Felder der Protokoll-Version NULL sind, bedeutet dies, dass der BIN-Bereich des Karten-Issuers nicht für 3DS 2.0 registriert ist und ein Fallback auf 3DS 1.0 für Transaktionen erforderlich ist, die unter den Geltungsbereich der PSD2 SCA fallen.

Achten Sie beim Zerlegen von versioningData bitte auch auf das Subelement errorDetails, das den Grund angibt, falls einige Felder nicht ausgefüllt sind (z.B. Ungültige Kontonumber des Karteninhabers übergeben, nicht verfügbare Kartenbereichsdaten, Fehler beo Codieren/Serialisieren der 3DS Methoden-Daten usw.)

(info) BASEURL= https://www.computop-paygate.com/

{
	"threeDSServerTransID": "14dd844c-b0fc-4dfe-8635-366fbf43468c",
	"acsStartProtocolVersion": "2.1.0",
	"acsEndProtocolVersion": "2.1.0",
	"dsStartProtocolVersion": "2.1.0",
	"dsEndProtocolVersion": "2.1.0",
	"threeDSMethodURL": "http://www.acs.com/script",
	"threeDSMethodDataForm": "eyJ0aHJlZURTTWV0aG9kTm90aWZpY2F0aW9uVVJMIjoiaHR0cHM6Ly93d3cuY29tcHV0b3AtcGF5Z2F0ZS5jb20vY2JUaHJlZURTLmFzcHg_YWN0aW9uPW10aGROdGZuIiwidGhyZWVEU1NlcnZlclRyYW5zSUQiOiIxNGRkODQ0Yy1iMGZjLTRkZmUtODYzNS0zNjZmYmY0MzQ2OGMifQ==",
	"threeDSMethodData": {
		"threeDSMethodNotificationURL": "BASEURL/cbThreeDS.aspx?action=mthdNtfn",
		"threeDSServerTransID": "14dd844c-b0fc-4dfe-8635-366fbf43468c"
	}
}


3DS Methode

Die 3DS Methode ermöglicht das Erfassen zusätzlicher Browserinformationen durch einen ACS vor Erhalt der Authensisierungsanfrage (AReq), um die Risikobeurteilung der Transaktion zu erleichtern. Die Unterstützung der 3DS Methode ist optional und liegt im Ermessen des Issuers.

Das Objekt versioningData enthält einen Wert für threeDSMethodURL. Der Händler sollte die 3DS Methode über einen versteckten HTML-iFrame im Browser des Karteninhabers aufrufen und ein Formular mit einem Feld namens threeDSMethodData über HTTP POST an die ACS 3DS Methoden-URL senden.

3DS Methode: threeDSMethodURL

Beachten Sie bitte, dass die threeDSMethodURL vom Computop Paygate ausgefüllt wird, falls der Issuer die 3DS Methode nicht unterstützt. Der 3DS Methoden-Formular-Post wie unten dargestellt muss unabhängig davon ausgeführt werden, ob dies vom Issuer unterstützt wird. Das ist notwending, um die direkte Kommunikation zwischen dem Browser und dem Computop Paygate im Falle einer angeordneten Challenge oder eines reibungslosen Ablaufs zu erleichtern.

3DS Method: Keine Issuer threeDSMethodURL

3-D Secure Method Form Post

<form name="frm" method="POST" action="Rendering URL">
    <input type="hidden" name="threeDSMethodData" value="eyJ0aHJlZURTU2VydmVyVHJhbnNJRCI6IjNhYzdjYWE3LWFhNDItMjY2My03OTFiLTJhYzA1YTU0MmM0YSIsInRocmVlRFNNZXRob2ROb3RpZmljYXRpb25VUkwiOiJ0aHJlZURTTWV0aG9kTm90aWZpY2F0aW9uVVJMIn0">
</form>

Der ACS interagiert mit dem Browser des Karteninhabers über den HTML-iFrame und speichert dann die zutreffenden Werte mit der 3DS Server Transaction ID für die Verwendung, wenn eine nachfolgende Authentisierungs-Nachricht empfangen wird, welche die gleiche 3DS Server Transaction ID enthält.


Netcetera 3DS Web SDK

Sie können nach eigenem Ermessen die Operationen init3DSMethod oder createIframeAndInit3DSMethod vom nca3DSWebSDK verwenden, um die 3DS Methode zu initialisieren. Bitte beachten Sie dazu das Integrations-Handbuch unter https://mpi.netcetera.com/3dsserver/doc/current/integration.html#Web_Service_API.

Nachdem die 3DS Methode abgeschlossen ist, weist der ACS den Browser des Karteninhabers über das iFrame-Antwortdokument an, threeDSMethodData als ein verstecktes Formularfeld an die 3DS Method Notification URL zu übermitteln.

ACS Response Document

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8"/>
    <title>Identifying...</title>
</head>
<body>
<script>
    var tdsMethodNotificationValue = 'eyJ0aHJlZURTU2VydmVyVHJhbnNJRCI6ImUxYzFlYmViLTc0ZTgtNDNiMi1iMzg1LTJlNjdkMWFhY2ZhMiJ9';

    var form = document.createElement("form");
    form.setAttribute("method", "post");
    form.setAttribute("action", "notification URL");

    addParameter(form, "threeDSMethodData", tdsMethodNotificationValue);

    document.body.appendChild(form);
    form.submit();

    function addParameter(form, key, value) {
        var hiddenField = document.createElement("input");
        hiddenField.setAttribute("type", "hidden");
        hiddenField.setAttribute("name", key);
        hiddenField.setAttribute("value", value);
        form.appendChild(hiddenField);
    }
</script>
</body>
</html>

3-D Secure Method Notification Form

<form name="frm" method="POST" action="3DS Method Notification URL">
    <input type="hidden" name="threeDSMethodData" value="eyJ0aHJlZURTU2VydmVyVHJhbnNJRCI6ImUxYzFlYmViLTc0ZTgtNDNiMi1iMzg1LTJlNjdkMWFhY2ZhMiJ9">
</form>


Beachten SIe bitte, dass die threeDSMethodNotificationURL wie sie in den Base64-codierten threeDSMethodData eingebettet ist, auf das Computop Paygate weist und nicht verändert werden darf. Die Händler-Benachrichtigung wird an die URLNotify geliefert, wie sie in der Originalanfrage übermittelt oder für die MerchantID im Computop Paygate konfiguriert ist.

Authentisierung

Wenn die 3DS-Methode vom ACS des Issuers unterstützt wird und vom Händler aufgerufen wurde, setzt das Computop Paygate automatisch mit der Authentisierungsanfrage fort, nachdem die 3DS-Methode abgeschlossen ist (d.h. 3DS Methoden-Benachrichtigung).

Das Ergebnis der Authentisierung wird per HTTP POST an die URLNotify übertragen. Es kann anzeigen, dass der Karteninhaber authentisiert worden ist oder dass eine weitere Interaktion des Karteninhabers (d.h. Challenge) für den Abschluss der Authentisierung erforderlich ist.

Falls für den Karteninhaber eine Challenge für nötig angesehen ist, überträgt das Computop Paygate ein JSON-Objekt im Body der HTTP Browser-Antwort mit den Elementen acsChallengeMandated, challengeRequest, base64EncodedChallengeRequest und acsURL. Anderenfalls setzt das Computop Paygate in einem reibungslosen Ablauf automatisch fort und antwortet dem Browser des Karteninhabers, sobald die Autorisierung abgeschlossen ist.

Karteninhaber-Challenge: Browser-Antwort


Browser Challenge-Antwort

Datenelemente

Oops, it seems that you need to place a table or a macro generating a table within the Table Filter macro.

The table is being loaded. Please wait for a bit ...

KeyFormatCNDDescriptionBeschreibung

acsChallengeMandated

boolean

M

Indication of whether a challenge is required for the transaction to be authorised due to local/regional mandates or other variable:

  • true → Challenge is mandated by local/regional regulations
  • false → Challenge is not mandated by local/regional regulations, but is deemed necessary by the ACS

Zeigt an, on eine Challenge für die Autorisierung einer Transaktion wegen lokaler/regionaler Vorschriften oder anderer Variablen nötig ist:

  • true → Challenge ist obligatorisch wegen lokaler/regional Vorschriften
  • false → Challenge ist nicht obligatorisch wegen lokaler/regional Vorschriften, wird aber von ACS als nötig angesehen

challengeRequest

object

M

Challenge request object

Objekt Challenge-Anfrage

base64EncodedChallengeRequest

string

M

Base64-encoded Challenge Request object

Base64-codiertes Objekt Challenge-Anfrage

acsURL

string

M

Fully qualified URL of the ACS to be used to post the Challenge Request

Vollständige URL des ACS, die für das Posten der Challenge-Anfrage verwendet werden soll

Schema Browser Challenge-Antwort

{
	"$schema": "http://json-schema.org/draft-07/schema#",
	"type": "object",
	"properties": {
		"acsChallengeMandated": {"type": "boolean"},
		"challengeRequest": {"type": "object"},
		"base64EncodedChallengeRequest": {"type": "string"},
		"acsURL": {"type": "string"}
	},
	"required": ["acsChallengeMandated", "challengeRequest", "base64EncodedChallengeRequest", "acsURL"],
	"additionalProperties": false
}

Beispiel Browser Challenge-Antwort

{
	"acsChallengeMandated": false,
	"challengeRequest": {
		"threeDSServerTransID": "8a880dc0-d2d2-4067-bcb1-b08d1690b26e",
		"acsTransID": "d7c1ee99-9478-44a6-b1f2-391e29c6b340",
		"messageType": "CReq",
		"messageVersion": "2.1.0",
		"challengeWindowSize": "01",
		"messageExtension": [
			{
				"name": "emvcomsgextInChallenge",
				"id": "tc8Qtm465Ln1FX0nZprA",
				"criticalityIndicator": false,
				"data": "messageExtensionDataInChallenge"
			}
		]
	},
	"base64EncodedChallengeRequest": "base64-encoded-challenge-request",
	"acsURL": "acsURL-to-post-challenge-request"
}

Authentisierungs-Benachrichtigung

Die Datenelemente der Authentisierungs-Benachrichtigung stehen in folgender Tabelle.

Oops, it seems that you need to place a table or a macro generating a table within the Table Filter macro.

The table is being loaded. Please wait for a bit ...

KeyFormatCNDDescriptionBeschreibung

mid

ans..30

M

MerchantID, assigned by Computop

HändlerID, die von Computop vergeben wird

KeyFormatCNDDescriptionBeschreibung
PayID

an32

M

ID assigned by Paygate for the payment, e.g. for referencing in batch files as well as for capture or credit request.

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

KeyFormatCNDDescriptionBeschreibung
TransID

ans..64

MTransactionID provided by you which should be unique for each paymentIhre eigene TransaktionsID, die für jede Zahlung eindeutig sein muss

KeyFormatCNDDescriptionBeschreibung
Code

an8

M

Error code according to Paygate Response Codes (A4 Error codes)

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

KeyFormatCNDDescriptionBeschreibung

MAC

an64

M
Hash Message Authentication Code (HMAC) with SHA-256 algorithm. Details can be found here:
Hash Message Authentication Code (HMAC) mit SHA-256-Algorithmus. Details finden Sie hier:

KeyFormatCNDDescriptionBeschreibung

authenticationResponse

JSON

M

Response object in return of the authentication request with the ACS

Antwort-Objekt als Rückgabe zur Authentisierungs-Anfrage beim ACS

Browser Challenge

Wenn eine Challenge für nötig angesehen wird (siehe challengeRequest), erfolgt die Browser Challenge im Browser des Karteninhabers. Zum Erzeugen einer Challenge ist es erforderlich, den Wert base64EncodedChallengeRequest über ein HTML-iFrame an die ACS URL zu posten.

Challenge-Anfrage

<form name="challengeRequestForm" method="post" action="acsChallengeURL">
	<input type="hidden" name="creq" value="ewogICAgInRocmVlRFNTZXJ2ZXJUcmFuc0lEIjogIjhhODgwZGMwLWQyZDItNDA2Ny1iY2IxLWIwOGQxNjkwYjI2ZSIsCiAgICAiYWNzVHJhbnNJRCI6ICJkN2MxZWU5OS05NDc4LTQ0YTYtYjFmMi0zOTFlMjljNmIzNDAiLAogICAgIm1lc3NhZ2VUeXBlIjogIkNSZXEiLAogICAgIm1lc3NhZ2VWZXJzaW9uIjogIjIuMS4wIiwKICAgICJjaGFsbGVuZ2VXaW5kb3dTaXplIjogIjAxIiwKICAgICJtZXNzYWdlRXh0ZW5zaW9uIjogWwoJCXsKCQkJIm5hbWUiOiAiZW12Y29tc2dleHRJbkNoYWxsZW5nZSIsCgkJCSJpZCI6ICJ0YzhRdG00NjVMbjFGWDBuWnByQSIsCgkJCSJjcml0aWNhbGl0eUluZGljYXRvciI6IGZhbHNlLAoJCQkiZGF0YSI6ICJtZXNzYWdlRXh0ZW5zaW9uRGF0YUluQ2hhbGxlbmdlIgoJCX0KICAgIF0KfQ==">
</form>

Sie können die Operationen init3DSChallengeRequest oder createIFrameAndInit3DSChallengeRequest aus dem nca3DSWebSDK verwenden, um die Challenge-Nachricht an den Browser des Karteninhabers zu übermitteln.

3DS Challenge-Anfrage initialisieren - Beispiel

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <script src="nca-3ds-web-sdk.js" type="text/javascript"></script>
    <title>Init 3-D Secure Challenge Request - Example</title>
</head>
<body>
<!-- This example will show how to initiate Challenge Reqeuests for different window sizes. -->
<div id="frameContainer01"></div>
<div id="frameContainer02"></div>
<div id="frameContainer03"></div>
<div id="frameContainer04"></div>
<div id="frameContainer05"></div>
<iframe id="iframeContainerFull" name="iframeContainerFull" width="100%" height="100%"></iframe>
  
<script type="text/javascript">
    // Load all containers
    iFrameContainerFull = document.getElementById('iframeContainerFull');
    container01 = document.getElementById('frameContainer01');
    container02 = document.getElementById('frameContainer02');
    container03 = document.getElementById('frameContainer03');
    container04 = document.getElementById('frameContainer04');
    container05 = document.getElementById('frameContainer05');
  
  
    // nca3DSWebSDK.init3DSChallengeRequest(acsUrl, creqData, container);
    nca3DSWebSDK.init3DSChallengeRequest('http://example.com', 'base64-encoded-challenge-request', iFrameContainerFull);
  
    // nca3DSWebSDK.createIFrameAndInit3DSChallengeRequest(acsUrl, creqData, challengeWindowSize, frameName, rootContainer, callbackWhenLoaded);
    nca3DSWebSDK.createIFrameAndInit3DSChallengeRequest('http://example.com', 'base64-encoded-challenge-request', '01', 'threeDSCReq01', container01);
    nca3DSWebSDK.createIFrameAndInit3DSChallengeRequest('http://example.com', 'base64-encoded-challenge-request', '02', 'threeDSCReq02', container02);
    nca3DSWebSDK.createIFrameAndInit3DSChallengeRequest('http://example.com', 'base64-encoded-challenge-request', '03', 'threeDSCReq03', container03);
    nca3DSWebSDK.createIFrameAndInit3DSChallengeRequest('http://example.com', 'base64-encoded-challenge-request', '04', 'threeDSCReq04', container04);
    nca3DSWebSDK.createIFrameAndInit3DSChallengeRequest('http://example.com', 'base64-encoded-challenge-request', '05', 'threeDSCReq05', container05, () => {
        console.log('Iframe loaded, form created and submitted');
    });
</script>
  
</body>
</html>

Sobald die Challenge des Karteninhabers abgeschlossen, abgebrochen oder per Zeitüberschreitung beendet ist, weist der ACS den Browser an, die Ergebnisse per Post an die in der Challenge-Anfrage angegebene Benachrichtigungs-URL zu senden und eine Ergebnis-Anfrage (RReq) über den Directory Server an den 3DS Server zu senden.

Beachten Sie bitte, dass die in der Challenge-Anfrage übergebene Benachrichtigungs-URL auf das Computop Paygate zeigt und nicht verändert werden darf.

Autorisierung

Nachdem die erfolgreiche Authentisierung des Karteninhabers oder der Nachweis der versuchten Authentisierung/Verifizierung bereitgestellt ist, setzt das Computop Paygate die Zahlungsautorisierung automatisch fort.

Falls die Authentisierung des Karteninhabers nicht erfolgreich war oder der Nachweise der versuchten Authentisierung/Verifizierung nicht bereitgestellt werden kann, setzt das Computop Paygate nicht mit einer Autorisierungsanfrage fort.

In beiden Fällen liefert das Paygate eine Benachrichtigung mit dem Ergebnis der Authentifizierung an die vom Händler angegebene URLNotify mit den Datenelementen gemäß nachstehender Tabelle.

Zahlungs-Benachrichtigung

Oops, it seems that you need to place a table or a macro generating a table within the Table Filter macro.

The table is being loaded. Please wait for a bit ...

KeyFormatCNDDescriptionBeschreibung

mid

ans..30

M

MerchantID, assigned by Computop

HändlerID, die von Computop vergeben wird

KeyFormatCNDDescriptionBeschreibung
msgver

ans..5

M

Computop Paygate Message version. Valid values:

ValueDescription
2.0With 3-D Secure 2.x a lot of additional data were required (e.g. browser-information, billing/shipping-address, account-info, ...) to improve authentication processing. To handle these information the JSON-objects have been put in place to handle such data. To indicate that these data are used the MsgVer has been implemented.

Computop Paygate Message-Version. Zulässige Werte:

WertBeschreibung
2.0Mit 3-D Secure 2.x wurde eine Vielzahl zusätzlicher Daten (Browser-Information, Rechnungs-/Versand-Adresse, ...) erforderlich, um den Authentifizierungs-Prozess zu optimieren. Um diese Informationen zu handhaben, wurden die JSON-Objekte eingeführt. Der Parameter MsgVer zeigt an, dass diese Daten verwendet werden.

KeyFormatCNDDescriptionBeschreibung
PayID

an32

M

ID assigned by Paygate for the payment, e.g. for referencing in batch files as well as for capture or credit request.

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

KeyFormatCNDDescriptionBeschreibung
XID

an32

M

ID for all single transactions (authorisation, capture, credit note) for one payment assigned by Paygate

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

KeyFormatCNDDescriptionBeschreibung
TransID

ans..64

MTransactionID provided by you which should be unique for each paymentIhre eigene TransaktionsID, die für jede Zahlung eindeutig sein muss

KeyFormatCNDDescriptionBeschreibung
schemeReferenceID

ans..64

C

Card scheme specific transaction ID required for subsequent credential-on-file payments, delayed authorizations and resubmissions.

Mandatory: CredentialOnFile – initial false – unscheduled MIT / recurring

schemeReferenceID is returned for 3DS2-payments. In case of fallback to 3DS1 you will also need to check for TransactionId.

The schemeReferenceID is a unique identifier generated by the card brands and as a rule Computop merchants can continue to use the SchemeReferenceIDs for subscription plans that were created while using another PSP environment / Paygate MerchantID / Acquirer ContractID / Acquirer.

Spezifische Transaktions-ID des Kartenschemas, die für nachfolgende Zahlungen mit gespeicherten Zugangsdaten, verzögerte Autorisierungen und Wiedereinreichungen erforderlich ist.

Pflicht: CredentialOnFile – initial false – unschedule MIT / recurring

schemeReferenceID wird bei 3DS2-Zahlungsvorgängen zurückgegeben. Bei einem Fallback auf 3DS1 prüfen Sie bitte zusätzlich auf TransactionId.

Die SchemeReferenceID ist eine eindeutige Kennung, die von den Kartenmarken generiert wird. In der Regel können Computop-Händler die SchemeReferenceIDs für Abonnements übergreifend verwenden, welche unter Verwendung eines anderen PSP / separater Paygate-MerchantID / separater Acquirer ContractID / Acquirer erstellt wurden.

KeyFormatCNDDescriptionBeschreibung

TrxTime

an21

M

Transaction time stamp in format DD.MM.YYYY HH:mm:ssff

Zeitstempel der Transaktion im Format DD.MM.YYYY HH:mm:ssff

Status

a..20

M

Status of the transaction.

Values accepted:

  • Authorized

  • OK (Sale)

  • PENDING
  • FAILED

In case of Authentication-only the Status will be either OK or FAILED .

Status der Transaktion.

Zulässige Werte:

  • Authorized

  • OK (Sale)

  • PENDING
  • FAILED

Im Falle von nur Authentisierung ist der Status entweder OK oder FAILED .

KeyFormatCNDDescriptionBeschreibung
Description

ans..1024

M
Further details in the event that payment is rejected. Please do not use the Description but the Code parameter for the transaction status analysis!
Nähere Beschreibung bei Ablehnung der Zahlung. Bitte nutzen Sie nicht den Parameter Description, sondern Code für die Auswertung des Transaktionsstatus!

KeyFormatCNDDescriptionBeschreibung
Code

an8

M

Error code according to Paygate Response Codes (A4 Error codes)

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

KeyFormatCNDDescriptionBeschreibung

MAC

an64

M
Hash Message Authentication Code (HMAC) with SHA-256 algorithm. Details can be found here:
Hash Message Authentication Code (HMAC) mit SHA-256-Algorithmus. Details finden Sie hier:

KeyFormatCNDDescriptionBeschreibung

card

JSON

M

Card data

Kartendaten

ipinfo

JSON

O

Object containing IP information

Objekt mit IP-Informationen

threedsdata

JSON

M

Authentication data

Authentisierungsdaten

resultsresponse

JSON

C

In case the authentication process included a cardholder challenge additional information about the challenge result will be provided.

Falls der Authentisierungsprozess eine Challenge des Karteninhabers enthalten hat, werden zusätzliche Informationen über das Ergebnis der Challenge bereitgestellt
externalPaymentDataJSONOOptional additional data from acquirer/issuer/3rd party for authorization.Optionale Daten des Acquirers/Issuers/externen Dienstleisters für eine Autorisierung

KeyFormatCNDDescriptionBeschreibung
PCNr

n16

O

Pseudo Card Number: Random number generated by Computop Paygate which represents a genuine credit card number. The pseudo card number (PCN) starts with 0 and the last 3 digits correspond to those of the real card number. The PCN can be used like a genuine card number for authorisation, capture and credits.

PCNr is a response value from Computop Paygate and is sent as CCNr in Request or part of card-JSON

Pseudo Card Number: Vom Computop Paygate generierte Zufallszahl, die eine reale Kreditkartennummer repräsentiert. Die Pseudokartennummer (PKN) beginnt mit 0, und die letzten 3 Stellen entsprechen denen der realen Kartennummer. Die PKN kann wie eine Kreditkartennummer für Autorisierung, Buchung und Gutschriften verwendet werden.

PCNr ist ein Antwortwert von Computop Paygate und kann ebenfalls als CCNr im Request oder als Teil von card-JSON verwendet werden.

Browser Zahlungs-Antwort

Zusätzlich werden nachstehende Datenelemente im JSON-Format im Body der HTTP-Antwort zum Browser des Karteninhabers übertragen. Beachten Sie bitte, dass die Datenelemente (d.h. MID, Len, Data) base64-codiert sind.

Datenelemente

Oops, it seems that you need to place a table or a macro generating a table within the Table Filter macro.

The table is being loaded. Please wait for a bit ...

KeyFormatCNDDescriptionBeschreibung

mid

ans..30

M

MerchantID, assigned by Computop

HändlerID, die von Computop vergeben wird

KeyFormatCNDDescriptionBeschreibung

Len

integer

M

Length of the unencrypted Data string

Länge des unverschlüsselten Strings Data

Data

string

M

Blowfish encrypted string containing a JSON object with MID , PayID and TransID

Blowfish-verschlüsselter String, der ein JSON-Objekt mit MID , PayID und TransID enthält

Schema

{
	"$schema": "http://json-schema.org/draft-07/schema#",
	"type": "object",
	"properties": {
		"MID": {
			"type": "string"
		},
		"Len": {
			"type": "integer"
		},
		"Data": {
			"type": "string"
		}
	},
	"required": ["MID", "Len", "Data"],
	"additionalProperties": false
}

Händler sollten diese Datenelemente zur Entschlüsselung und für den Abgleich mit der Zahlungs-Benachrichtigung am ihren Server weiterleiten. Basierend auf dem Zahlungsergebnis kann der Händler-Server eine entsprechende Antwort an den Browser des Karteninhabers senden (z.B. Erfolgsseite).

Entschlüsseltes Objekt Data

Oops, it seems that you need to place a table or a macro generating a table within the Table Filter macro.

The table is being loaded. Please wait for a bit ...

KeyFormatCNDDescriptionBeschreibung

mid

ans..30

M

MerchantID, assigned by Computop

HändlerID, die von Computop vergeben wird

KeyFormatCNDDescriptionBeschreibung
PayID

an32

M

ID assigned by Paygate for the payment, e.g. for referencing in batch files as well as for capture or credit request.

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

KeyFormatCNDDescriptionBeschreibung
TransID

ans..64

MTransactionID provided by you which should be unique for each paymentIhre eigene TransaktionsID, die für jede Zahlung eindeutig sein muss

Beispiel für entschlüsseltes Objekt Data

MID=YourMID&PayID=PayIDassignedbyPlatform&TransID=YourTransID





Buchung / Gutschrift / Storno

Buchung

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:


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:

Oops, it seems that you need to place a table or a macro generating a table within the Table Filter macro.

The table is being loaded. Please wait for a bit ...

KeyRESTFormatCNDDescriptionBeschreibung

MerchantID

BasicAuth.Username

ans..30

M

MerchantID, assigned by Computop. Additionally this parameter has to be passed in plain language too.

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

KeyRESTFormatCNDDescriptionBeschreibung
PayID"paymentId": "..."

an32

M

ID assigned by Paygate for the payment, e.g. for referencing in batch files as well as for capture or credit request.

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

 

Key

REST

Format

CND

Description

Beschreibung

TransID

"transactionId": "..."

ans..64

M

TransactionID which should be unique for each payment

Please note for some connections the different formats that are given within the specific parameters.

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

Merchant’s unique reference number, which serves as payout reference in the acquirer EPA file. Please note, without the own shop reference delivery you cannot read out the EPA transaction and regarding the additional Computop settlement file (CTSF) we cannot add the additional payment data.

(not with EVO Payments, for CardComplete in the format an..25, for Cofidis in the format n..15, for Omnipay in the format ns..15, for RBI in the format ns..20)

Only ASCII characters allowed, special characters ("Umlaute", diacritics) are not allowed and must be replaced by their ASCII-representation (e.g. ü → ue, é → e, ...).

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, ...).

KeyRESTFormatCNDDescriptionBeschreibung
Amount"amount": { "value": ...}

n..10

M

Amount in the smallest currency unit (e.g. EUR Cent). Please contact the Computop Helpdesk, if you want to capture amounts <100 (smallest currency unit).

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.

KeyRESTFormatCNDDescriptionBeschreibung
Currency"amount": { "currency": "..."}

a3

M

Currency, three digits DIN / ISO 4217, e.g. EUR, USD, GBP. Please find an overview here: A1 Currency table

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

KeyRESTFormatCNDDescriptionBeschreibung

MAC

---

an64

M
Hash Message Authentication Code (HMAC) with SHA-256 algorithm. Details can be found here:
Hash Message Authentication Code (HMAC) mit SHA-256-Algorithmus. Details finden Sie hier:

KeyRESTFormatCNDDescriptionBeschreibung
ReqId"requestId": "..."

ans..32

O

To avoid double payments or actions (e.g. by ETM), enter an alphanumeric value which identifies your transaction and may be assigned only once. If the transaction or action is submitted again with the same ReqID, Computop Paygate will not carry out the payment or new action, but will just return the status of the original transaction or action.

Please note that the Computop Paygate must have a finalized transaction status for the first initial action (authentication/authorisation). This does not apply to 3-D Secure authentications that are terminated by a timeout. The 3-D Secure Timeout status does not count as a completed status in which the ReqID functionality on Paygate does not take effect. Submissions with identical ReqID for an open status will be processed regularly.

Notice: Please note that a ReqID is only valid for 12 month, then it gets deleted at the Paygate.

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.

Key

REST

Format

CND

Description

Beschreibung

FinishAuth

"finishAuth": "..."

a1

C

Only with ETM: Transmit value <Y> in order to stop the renewal of guaranteed authorisations and rest amounts after partial captures. Please use this parameter only if you are using the additional function ETM (Extended Transactions Managament). (not with Clearhaus)

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

Card holder information: Name (not with Clearhaus)

For Banksys: Name of merchant. For VISA transactions up to 25 characters are allowed, for MasterCard only up to 22.

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

Card holder information: City (not with Clearhaus)

For Banksys: City of merchant. The value is truncated after 13 characters.

Karteninhaber-Information: Ort (Nicht bei Clearhaus)

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

CHDesc

---

ans..22

OC

Only with Clearhaus: Text printed on the customer’s credit card bill. Only printable ASCII characters from 0x20 to 0x7E

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:

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

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

Oops, it seems that you need to place a table or a macro generating a table within the Table Filter macro.

The table is being loaded. Please wait for a bit ...

KeyRESTFormatCNDDescriptionBeschreibung

mid

"merchantId": "..."

ans..30

M

MerchantID, assigned by Computop

HändlerID, die von Computop vergeben wird

KeyRESTFormatCNDDescriptionBeschreibung
PayID"paymentId": "..."

an32

M

ID assigned by Paygate for the payment, e.g. for referencing in batch files as well as for capture or credit request.

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

KeyRESTFormatCNDDescriptionBeschreibung
XID"xId": "..."

an32

M

ID for all single transactions (authorisation, capture, credit note) for one payment assigned by Paygate

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

Key

REST

Format

CND

Description

Beschreibung

TransID

"transactionId": "..."

ans..64

M

Merchant’s transaction number.

Please note for some connections the different formats that are given within the specific parameters.

Transaktionsnummer des Händlers.

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

KeyRESTFormatCNDDescriptionBeschreibung
Status

"status": "OK"

"status": "FAILED"

a..50

M

OK (URLSuccess) or FAILED (URLFailure)

OK (URLSuccess) oder FAILED (URLFailure)

KeyRESTFormatCNDDescriptionBeschreibung
Description"description": "..."

ans..1024

M
Further details in the event that payment is rejected. Please do not use the Description but the Code parameter for the transaction status analysis!
Nähere Beschreibung bei Ablehnung der Zahlung. Bitte nutzen Sie nicht den Parameter Description, sondern Code für die Auswertung des Transaktionsstatus!

KeyRESTFormatCNDDescriptionBeschreibung
Code"code": ...

an8

M

Error code according to Paygate Response Codes (A4 Error codes)

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

Key

REST

Format

CND

Description

Beschreibung

RefNr

"referenceNumber": "..."

ns..30

C

Merchant’s unique reference number, which serves as payout reference in the acquirer EPA file. Please note, without the own shop reference delivery you cannot read out the EPA transaction and regarding the additional Computop settlement file (CTSF) we cannot add the additional payment data.

(not with EVO Payments, for Card Complete in the format an..25, for Omnipay in the format ns..15, for RBI in the format ns..20)

Only ASCII characters allowed, special characters ("Umlaute", diacritics) are not allowed and must be replaced by their ASCII-representation (e.g. ü → ue, é → e, ...).

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 Card Complete im Format an..25, 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

Only in the case of Card Complete: Authorisation ID returned by Card Complete

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

Amount

"amountValue": "..."

n..10

OC

Only with Clearhaus: Amount in the smallest currency unit (e.g. EUR Cent)

If the actual amount differs from the requested amount this will be returned.

Only with MasaPay: The amount has to be equal to the originally authorised amount.

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

Only with Clearhaus: Only if configured: External error code (downstream system).

Only with MasaPay: Format ans..10, error code from MasaPay.

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

Nur bei MasaPay: Format ans..10, Fehlercode von MasaPay.

ErrorText

"errorText": "..."

ans.128

OC

Only with Clearhaus: Detailed Clearhaus error message.

Only with MasaPay: Format ans..128, detailed MasaPay error message.

Is returned only if Status=FAILED. Use is possible only in agreement with Computop Helpdesk

Nur bei Clearhaus: Detaillierte Clearhaus Fehlermeldung.

Nur bei MasaPay: Format ans..128, Detaillierte MasaPay Fehlermeldung.

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

TransactionID

"clearhausTransactionId": "..."

ans36

OC

Only with Clearhaus: Transaction number from Clearhaus

Nur bei Clearhaus: Transaktionsnummer von Clearhaus

TID"cofidisTransactionId": "..."n..15MOnly with Cofidis: If RefNr was submitted, it's value will be returned. Otherwise the first 15 digits of TransactionID will be returned.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



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:


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:

Oops, it seems that you need to place a table or a macro generating a table within the Table Filter macro.

The table is being loaded. Please wait for a bit ...

KeyRESTFormatCNDDescriptionBeschreibung

MerchantID

BasicAuth.Username

ans..30

M

MerchantID, assigned by Computop. Additionally this parameter has to be passed in plain language too.

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

KeyRESTFormatCNDDescriptionBeschreibung
PayID"paymentId": "..."

an32

M

ID assigned by Paygate for the payment, e.g. for referencing in batch files as well as for capture or credit request.

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

Key

REST

Format

CND

Description

Beschreibung

TransID

"transactionId": "..."

ans..64

M

TransactionID which should be unique for each payment

Please note for some connections the different formats that are given within the specific parameters.

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.

KeyRESTFormatCNDDescriptionBeschreibung
Amount"amount": { "value": ...}

n..10

M

Amount in the smallest currency unit (e.g. EUR Cent). Please contact the Computop Helpdesk, if you want to capture amounts <100 (smallest currency unit).

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.

KeyRESTFormatCNDDescriptionBeschreibung
Currency"amount": { "currency": "..."}

a3

M

Currency, three digits DIN / ISO 4217, e.g. EUR, USD, GBP. Please find an overview here: A1 Currency table

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

KeyRESTFormatCNDDescriptionBeschreibung

MAC

---

an64

M
Hash Message Authentication Code (HMAC) with SHA-256 algorithm. Details can be found here:
Hash Message Authentication Code (HMAC) mit SHA-256-Algorithmus. Details finden Sie hier:

Key

REST

Format

CND

Description

Beschreibung
RefNr"referenceNumber": "..."ns..30C

Merchant’s unique reference number, which serves as payout reference in the acquirer EPA file. Please note, without the own shop reference delivery you cannot read out the EPA transaction and regarding the additional Computop settlement file (CTSF) we cannot add the additional payment data.

(not with EVO Payments, Only for CardComplete, for Clearhaus (ns..30, optional, only printable ASCII characters from 0x20 to 0x7E), for RBI (ns..20, optional), for MasaPay (ns..30, optional), for Cofidis (n..15, optional).)

Notice: For CAPN multiple partial credits on the same day are allowed. Please note, that for each partial credit a seperate unique RefNr is required.

Only ASCII characters allowed, special characters ("Umlaute", diacritics) are not allowed and must be replaced by their ASCII-representation (e.g. ü → ue, é → e, ...).

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 MasaPay (ns..30, 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..768ODescription of refunded goods, unit prices, merchant’s comment etc. (not with Clearhaus)Beschreibung der gutgeschriebenen Artikel, Einzelpreise, Händlerkommentar etc. (Nicht bei Clearhaus)

KeyRESTFormatCNDDescriptionBeschreibung
ReqId"requestId": "..."

ans..32

O

To avoid double payments or actions (e.g. by ETM), enter an alphanumeric value which identifies your transaction and may be assigned only once. If the transaction or action is submitted again with the same ReqID, Computop Paygate will not carry out the payment or new action, but will just return the status of the original transaction or action.

Please note that the Computop Paygate must have a finalized transaction status for the first initial action (authentication/authorisation). This does not apply to 3-D Secure authentications that are terminated by a timeout. The 3-D Secure Timeout status does not count as a completed status in which the ReqID functionality on Paygate does not take effect. Submissions with identical ReqID for an open status will be processed regularly.

Notice: Please note that a ReqID is only valid for 12 month, then it gets deleted at the Paygate.

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.

Key

REST

Format

CND

Description

Beschreibung

Textfeld1

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

ans..30

O

Card holder information: Name (not with Clearhaus)

For Banksys: Name of merchant. For VISA transactions up to 25 characters are allowed, for MasterCard only up to 22.

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

Card holder information: City (not with Clearhaus)

For Banksys: City of merchant. The value is truncated after 13 characters.

Karteninhaber-Information: Ort (Nicht bei Clearhaus)

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

CHDesc

---

ans..22

OC

Only with Clearhaus: Text printed on the customer’s credit card bill. Only printable ASCII characters from 0x20 to 0x7E

Nur bei Clearhaus: Text, der auf der Kreditkartenabrechnung angezeigt wird. Nur ASCII druckbare Zeichen von 0x20 bis 0x7E
TID"safeChargeTransactionId": "..."ans..30OCOnly with SafeCharge: TransaktioncID of the capture to be credited, if the merchants wants to credit a specifc capture. If the parameter is nut submitted the last capture will be credited.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:

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

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

Oops, it seems that you need to place a table or a macro generating a table within the Table Filter macro.

The table is being loaded. Please wait for a bit ...

KeyRESTFormatCNDDescriptionBeschreibung

mid

"merchantId": "..."

ans..30

M

MerchantID, assigned by Computop

HändlerID, die von Computop vergeben wird

KeyRESTFormatCNDDescriptionBeschreibung
PayID"paymentId": "..."

an32

M

ID assigned by Paygate for the payment, e.g. for referencing in batch files as well as for capture or credit request.

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

KeyRESTFormatCNDDescriptionBeschreibung
XID"xId": "..."

an32

M

ID for all single transactions (authorisation, capture, credit note) for one payment assigned by Paygate

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

Key

REST

Format

CND

Description

Beschreibung

TransID

"transactionId": "..."

ans..64

M

Merchant’s transaction number.

Please note for some connections the different formats that are given within the specific parameters.

Transaktionsnummer des Händlers.

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

KeyRESTFormatCNDDescriptionBeschreibung
Status

"status": "OK"

"status": "FAILED"

a..50

M

OK (URLSuccess) or FAILED (URLFailure)

OK (URLSuccess) oder FAILED (URLFailure)

KeyRESTFormatCNDDescriptionBeschreibung
Description"description": "..."

ans..1024

M
Further details in the event that payment is rejected. Please do not use the Description but the Code parameter for the transaction status analysis!
Nähere Beschreibung bei Ablehnung der Zahlung. Bitte nutzen Sie nicht den Parameter Description, sondern Code für die Auswertung des Transaktionsstatus!

KeyRESTFormatCNDDescriptionBeschreibung
Code"code": ...

an8

M

Error code according to Paygate Response Codes (A4 Error codes)

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

Key

REST

Format

CND

Description

Beschreibung

Aid

"authorizationId": "..."

n6

OC

Only in the case of Card Complete: Authorisation ID returned by Card Complete

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

RefNr

"referenceNumber": "..."

an..25

OC

Merchant’s unique reference number, which serves as payout reference in the acquirer EPA file. Please note, without the own shop reference delivery you cannot read out the EPA transaction and regarding the additional Computop settlement file (CTSF) we cannot add the additional payment data.

Only for Card Complete, for Clearhaus (ans..30, optional, only printable ASCII characters from 0x20 to 0x7E), for RBI (ns..20, optional), for MasaPay (ns..30, optional), for Cofidis (n..15, optional).

Only ASCII characters allowed, special characters ("Umlaute", diacritics) are not allowed and must be replaced by their ASCII-representation (e.g. ü → ue, é → e, ...).

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 MasaPay (ns..30, 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

OC

Only with Clearhaus: Amount in the smallest currency unit (e.g. EUR Cent)

If the actual amount differs from the requested amount this will be returned.

Only with MasaPay: The amount has to be equal to the originally authorised amount.

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

Only with Clearhaus: Only if configured: External error code (downstream system).

Only with MasaPay: Format ans..10, error code from MasaPay.

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

Nur bei MasaPay: Format ans..10, Fehlercode von MasaPay.

ErrorText

"errorText": "..."

ans..128

OC

Only with Clearhaus: Detailed Clearhaus error message.

Only with MasaPay: Format ans..128, detailed MasaPay error message.

Is returned only if Status=FAILED. Use is possible only in agreement with Computop Helpdesk

Nur bei Clearhaus: Detaillierte Clearhaus Fehlermeldung.

Nur bei MasaPay: Format ans..128, Detaillierte MasaPay Fehlermeldung.

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

TransactionID

"clearhausTransactionId": "..."

ans36

OC

Only with Clearhaus: Transaction number from Clearhaus

Nur bei Clearhaus: Transaktionsnummer von Clearhaus

Ergebnis-Parameter für 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:


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:

Oops, it seems that you need to place a table or a macro generating a table within the Table Filter macro.

The table is being loaded. Please wait for a bit ...

KeyFormatCNDDescriptionBeschreibung

MerchantID

ans..30

M

MerchantID, assigned by Computop. Additionally this parameter has to be passed in plain language too.

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

Key

Format

CND

Description

Beschreibung

TransID

ans..64

M

TransactionID which should be unique for each payment

Please note for some connections the different formats that are given within the specific parameters.

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.

KeyFormatCNDDescriptionBeschreibung
Amount

n..10

M

Amount in the smallest currency unit (e.g. EUR Cent). Please contact the Computop Helpdesk, if you want to capture amounts <100 (smallest currency unit).

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.

KeyFormatCNDDescriptionBeschreibung
Currency

a3

M

Currency, three digits DIN / ISO 4217, e.g. EUR, USD, GBP. Please find an overview here: A1 Currency table

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

KeyFormatCNDDescriptionBeschreibung

MAC

an64

M
Hash Message Authentication Code (HMAC) with SHA-256 algorithm. Details can be found here:
Hash Message Authentication Code (HMAC) mit SHA-256-Algorithmus. Details finden Sie hier:

Key

Format

CND

Description

Beschreibung
RefNrns..30C

Merchant’s unique reference number, which serves as payout reference in the acquirer EPA file. Please note, without the own shop reference delivery you cannot read out the EPA transaction and regarding the additional Computop settlement file (CTSF) we cannot add the additional payment data.

(not with EVO Payments, Only for CardComplete, for Clearhaus (ns..30, optional, only printable ASCII characters from 0x20 to 0x7E), for RBI (ns..20, optional), for MasaPay (ns..30, optional), for Cofidis (n..15, optional).)

Only ASCII characters allowed, special characters ("Umlaute", diacritics) are not allowed and must be replaced by their ASCII-representation (e.g. ü → ue, é → e, ...).

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 MasaPay (ns..30, 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, ...).

OrderDescans..768ODescription of refunded goods, unit prices, merchant’s comment etc. (not with Clearhaus)Beschreibung der gutgeschriebenen Artikel, Einzelpreise, Händlerkommentar etc. (Nicht bei Clearhaus)

KeyFormatCNDDescriptionBeschreibung
ReqId

ans..32

O

To avoid double payments or actions (e.g. by ETM), enter an alphanumeric value which identifies your transaction and may be assigned only once. If the transaction or action is submitted again with the same ReqID, Computop Paygate will not carry out the payment or new action, but will just return the status of the original transaction or action.

Please note that the Computop Paygate must have a finalized transaction status for the first initial action (authentication/authorisation). This does not apply to 3-D Secure authentications that are terminated by a timeout. The 3-D Secure Timeout status does not count as a completed status in which the ReqID functionality on Paygate does not take effect. Submissions with identical ReqID for an open status will be processed regularly.

Notice: Please note that a ReqID is only valid for 12 month, then it gets deleted at the Paygate.

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.

KeyFormatCNDDescriptionBeschreibung
CCNr

n..19

M

Credit card number for credit card payments. 

It can be filled:

  • either with the real credit card number (PAN)
  • or with the pseudo card number that you have received previously in a Paygate response in parameter PCNr.

(info) With 3-D Secure 2.x the CCNr (PAN or PCNr) is sent as card.JSON.

(info) We recommend to use "Hosted Payment Page" or Credit Card Form (paySSL) for simplified PCI DSS certification and usage of PCNr.

Kreditkartennummer für Kreditkarten-Zahlungen.

Es kann wahlweise übergeben werden: 

  • entweder die richtige Kreditkartennummer (PAN)
  • oder die Pseudokartennummer, welche Sie zuvor in einer Paygate-Antwort als PCNr erhalten haben. 

(info) Mit 3-D Secure 2.x wird die CCNr (PAN oder PCNr) im card-JSON gesendet.

(info) Wir empfehlen die Verwendung der "Hosted Payment Page" oder des Kreditkartenformular (PaySSL) sowie Übergabe der PCNr zur vereinfachten PCI DSS Zertifizierung.

Key

Format

CND

Description

Beschreibung

CCCVC

n..4

O

Card verification number: The last 3 digits on the signature strip of the credit card. 4 numbers in the case of American Express.Kartenprüfnummer: Die letzten 3 Ziffern auf dem Unterschriftsfeld der Kreditkarte. Bei American Express 4 Ziffern.

CCExpiry

n6

M

Expiry date of the credit card in the format YYYYMM, e.g. 202507.

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

CCBrand

a..22

M

Credit card brand.

Please note the spelling! According to table of credit card brands!

Kreditkartenmarke.

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

UserData

ans..1024

OC

Only with Clearhaus: If specified at request, Paygate forwards the parameter with the payment result to the shop.

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

Textfeld1

ans..30

O

Not with Clearhaus: Card holder information: Name

For Banksys: Name of merchant. For VISA transactions up to 25 characters are allowed, for MasterCard only up to 22.

Nicht bei Clearhaus: Karteninhaber-Information: Name

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

Textfeld2

ans..30

O

Not with Clearhaus: Card holder information: City

For Banksys: City of merchant. The value is truncated after 13 characters.

Nicht bei Clearhaus: Karteninhaber-Information: Ort

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

CHDesc

ans..34

OC

Only with Clearhaus, format ans..22: Text printed on the customer’s credit card bill. Only printable ASCII characters from 0x20 to 0x7E

Only for Credorax: Text printed on the customer’s credit card bill.

This function must be enabled by Credorax and have the following structure.

1) merchant DBA name (up to 20 characters)

2) asterisk

3) additional text (up to 13 characters).

e.g. Computop*Test

This value can be alternatively permanently defined by Computop Helpdesk

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

Nur bei Credorax: Text, der auf der Kreditkartenabrechnung angezeigt wird.

Diese Funktion muss von Credorax freigeschalten werden und folgenden Aufbau haben.

1) merchant DBA Name (bis zu 20 Zeichen)

2) Stern

3) zusätzlicher Text (bis zu 13 Zeichen).

z.B. Computop *Test

Dieser Wert kann alternativ vom  Computop Helpdesk fest hinterlegt werden.

CreditCardHolder

an..255

MC

Only with Credorax, ECPCC: Name of the card holder  

Nur bei Credorax, ECPCC: Name des Karteninhabers   

Email

ans..64

MC

Only with Credorax, ECPCC: Email address of the customer

Nur bei Credorax, ECPCC: E-Mail-Adresse des Kunden

IPAddr

ans..15

OC

Only with Credorax, ECPCC: Customer´s IP address

Nur bei Credorax, ECPCC: IP-Adresse des Kunden

PaymentOfWinnings

ans..4

OC

In the case of the acquirer EMS (Omnipay) the merchant can control CFT credit notes in this way.
Transfer PaymentOfWinnings=True to credit a win rather than simply repaying a paid amount.

Beim Acquirer EMS (Omnipay) kann der Händler hiermit CFT-Gutschriften steuern.
Übergeben Sie PaymentOfWinnings=True, um einen Gewinn gutzuschreiben, anstatt nur einen eingezahlten Betrag zurückzuerstatten.

PaymentAddDataJSONCOnly with Omnipay: Additional data if PaymentOfWinnings=TrueNur bei OmniPay: Zusätzliche Daten, wenn PaymentOfWinnings=True

TransactionID

an..150

M

Additional reference number

Zusätzliche Referenznummer




Further address parameters in case of ECPCC connectionWeitere Adressparameter bei der Anbindung ECPCC

DateOfBirth

n8

O

Date of birth of the customer in format YYYYMMDD

Geburtsdatum des Kunden im Format YYYYYMMDD

Phone

n..32

O

Customer’s phone number

Telefonnummer des Kunden

FirstName

ans..255

M

First name of the customer

Vorname des Kunden

LastName

ans..255

M

Last name of the customer

Nachname des Kunden

AddrStreet

ans..255

O

Street name

Straßenname

AddressAddition

ans..255

O

Address c/o

Adresszusatz

AddrZip

an..9

O

Postcode

Postleitzahl

AddrCity

ans..255

O

City

Ort

AddrState

a2

O

Code of the customer’s Federal State

Code des Bundeslandes des Kunden

AddrCountryCode

a2

M

Country code according to ISO-3166-1, alphanumeric 2 chars

Ländercode im Format ISO-3166-1, alphanumerisch 2-stellig

sdFirstName

ans..255

O

First name in the delivery address

Vorname in der Lieferanschrift

sdLastName

ans..255

O

Surname in the delivery address

Nachname in der Lieferanschrift

sdStreet

ans..255

O

Street name in the delivery address

Straßenname der Lieferanschrift

sdAddressAddition

ans..255

O

Address addition in the delivery address

Adresszusatz der Lieferanschrift

sdZIPCode

an..9

O

Postcode in the delivery address

Postleitzahl der Lieferanschrift

sdCity

ans..255

O

Town/city in the delivery address

Ort der Lieferanschrift

sdState

a2

O

Code of Federal State in the delivery address

Code des Bundeslandes der Lieferanschrift

sdCountryCode

a2

O

Country code of delivery address according to ISO-3166-1, alphanumeric 2 chars

Ländercode der Lieferanschrift  im Format ISO-3166-1, alphanumerisch 2-stellig




Further address parameters in case of Kalixa connectionWeitere Adressparameter bei der Anbindung Kalixa

IPAddr

ans..15

M

Customer´s IP address

IP-Adresse des Kunden

BrowserSessionID

ans..64

M

Customer´s Session ID

SessionID des Kunden

CreditCardHolder

ans..100

M

Name of the card holder

Name des Karteninhabers

CustomerID

an..20

M

Customer number: Number to identify the customer

Kundennummer: Nummer zur Identifizierung des Kunden

Name

ans..100

C

User name of the customer

Benutzername des Kunden

FirstName

ans..100

C

First name of the customer

Vorname des Kunden

LastName

ans..100

C

Last name of the customer

Nachname des Kunden

Email

ans..64

C

Email address of the customer

E-Mail-Adresse des Kunden

Language

a2

C

Language of the customer according to ISO, alphanumeric 2-digits

Sprache des Kunden gemäß ISO, alphanumerisch 2-stellig

sdFirstName

ans..100

C

First name in the delivery address

Vorname in der Lieferanschrift

sdLastName

ans..100

C

Surname in the delivery address

Nachname in der Lieferanschrift

sdStreet

ans..200

C

Street name in the delivery address

Straßenname der Lieferanschrift

sdStreetNr

ans..5

C

Street number in the delivery address

Hausnummer der Lieferanschrift

sdZIPCode

an..20

C

Postcode in the delivery address

Postleitzahl der Lieferanschrift

sdCity

ans..40

C

Town/city in the delivery address

Ort der Lieferanschrift

sdState

a2

C

Code of Federal State in the delivery address

Code des Bundeslandes der Lieferanschrift

sdCountryCode

a2

C

Country code of delivery address according to ISO-3166-1, alphanumeric 2 chars

Ländercode der Lieferanschrift  im Format ISO-3166-1, alphanumerisch 2-stellig




Further address parameters in case of Vantiv connectionWeitere Adressparameter bei der Anbindung Vantiv

bdFirstName

ans..25

O

First name in the invoicing address

Vorname in der Rechnungsadresse

bdLastName

ans..25

O

Last name in the invoicing address

Nachname in der Rechnungsadresse

bdStreet

ans..35

O

Street name in the invoicing address

Please note that bdStreet and bdStreetNr together may have 34 characters maximum.

bdStreet and bdStreetNr are combined with a space character between and forwarded together. The total content is truncated after 35 characters.

Straßenname in der Rechnungsadresse

Bitte beachten Sie, dass bdStreet und bdStreetNr zusammen maximal 34 Zeichen haben dürfen.

bdStreet und bdStreetNr werden mit einem Leerzeichen getrennt zusammengefügt und gemeinsam weitergeleitet. Der Gesamtinhalt wird nach 35 Zeichen abgeschnitten.

bdStreetNr

ans..35

O

Street number in the invoicing address

Please note that bdStreet and bdStreetNr together may have 34 characters maximum.

bdStreet and bdStreetNr are combined with a space character between and forwarded together. The total content is truncated after 35 characters.

Hausnummer in der Rechnungsadresse

Bitte beachten Sie, dass bdStreet und bdStreetNr zusammen maximal 34 Zeichen haben dürfen.

bdStreet und bdStreetNr werden mit einem Leerzeichen getrennt zusammengefügt und gemeinsam weitergeleitet. Der Gesamtinhalt wird nach 35 Zeichen abgeschnitten.

bdStreet2

ans..35

O

Address addition in the billing address

Adresszusatz in der Rechnungsadresse

bdZIPCode

ans..20

O

Postcode in the invoicing address

Postleitzahl in der Rechnungsadresse

bdCity

ans..35

O

Town/city in the invoicing address

Ort in der Rechnungsadresse

bdState

ans..30

O

State/country in the invoicing address

Staat/Land in der Rechnungsadresse

bdCountryCode

a2

O

Country code of invoicing address according to ISO-3166-1, alphanumeric 2 chars

Ländercode der Rechnungsadresse im Format ISO-3166-1, alphanumerisch 2-stellig

bdMail

ans..100

O

Email address in the invoicing address

E-Mail in der Rechnungsadresse

bdPhone

ans..20

O

Phone number in the invoicing address

Telefonnummer in der Rechnungsanschrift

Parameter für Gutschrift von Kreditkartenzahlungen ohne Bezug


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

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

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

Oops, it seems that you need to place a table or a macro generating a table within the Table Filter macro.

The table is being loaded. Please wait for a bit ...

KeyFormatCNDDescriptionBeschreibung

mid

ans..30

M

MerchantID, assigned by Computop

HändlerID, die von Computop vergeben wird

KeyFormatCNDDescriptionBeschreibung
PayID

an32

M

ID assigned by Paygate for the payment, e.g. for referencing in batch files as well as for capture or credit request.

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

KeyFormatCNDDescriptionBeschreibung
XID

an32

M

ID for all single transactions (authorisation, capture, credit note) for one payment assigned by Paygate

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

Key

Format

CND

Description

Beschreibung

TransID

ans..64

M

Merchant’s transaction number.

Please note for some connections the different formats that are given within the specific parameters.

Transaktionsnummer des Händlers.

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

KeyFormatCNDDescriptionBeschreibung
Status

a..50

M

OK (URLSuccess) or FAILED (URLFailure)

OK (URLSuccess) oder FAILED (URLFailure)

KeyFormatCNDDescriptionBeschreibung
Description

ans..1024

M
Further details in the event that payment is rejected. Please do not use the Description but the Code parameter for the transaction status analysis!
Nähere Beschreibung bei Ablehnung der Zahlung. Bitte nutzen Sie nicht den Parameter Description, sondern Code für die Auswertung des Transaktionsstatus!

KeyFormatCNDDescriptionBeschreibung
Code

an8

M

Error code according to Paygate Response Codes (A4 Error codes)

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

Key

Format

CND

Description

Beschreibung

AID

n6

OC

Only in the case of Card Complete: Authorisation ID returned by Card Complete

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

RefNr

an..25

OC

Only for Card Complete: If a RefNr has been transmitted, it is returned.

Only ASCII characters allowed, special characters ("Umlaute", diacritics) are not allowed and must be replaced by their ASCII-representation (e.g. ü → ue, é → e, ...).

Nur bei Card Complete: Falls eine RefNr übermittelt wurde, wird sie wieder zurückgegeben.

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

n..10

OC

Only with Clearhaus: Amount in the smallest currency unit (e.g. EUR Cent)

If the actual amount differs from the requested amount this will be returned.

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

n5

OC

Only with Clearhaus: Only if configured: External error code (downstream system)

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

ErrorText

ans..128

OC

Only with Clearhaus: Detailed Clearhaus error message.

Is returned only if Status=FAILED. Use is possible only in agreement with Computop Helpdesk

Nur bei Clearhaus: Detaillierte Clearhaus Fehlermeldung.

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

UserData

ans..1024

OC

Only with Clearhaus: If specified at request, Paygate forwards the parameter with the payment result to the shop.

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

TransactionID

ans36

OC

Only with Clearhaus: Transaction number from Clearhaus

Nur bei Clearhaus: Transaktionsnummer von Clearhaus

PaymentSenderReferencean..19COnly with Omnipay: Reference number generated by the Acquirer that will be used to identify the payment transaction. It can be returned for MasterCard Payment of winnings transactions when the required additional parameters are submitted in the request.Nur bei Omnipay: Referenznummer des Acquirers, die zur Identifikation der Zahlungstransaktion verwendet wird. Sie kann für MasterCard Payment of winnings Transaktionen zurückgegeben werden, wenn die erforderlichen zusätzlichen Parameter übergeben worden sind.