Maintenance Work Notice!

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

Page tree

Search

Skip to end of metadata
Go to start of metadata

Paygate-Schnittstelle

Definitionen

Datenformate:

FormatBeschreibung

a

alphabetisch

as

alphabetisch mit Sonderzeichen

n

numerisch

an

alphanumerisch

ans

alphanumerisch mit Sonderzeichen

ns

numerisch mit Sonderzeichen

bool

Bool’scher Ausdruck (true oder false)

3

feste Länge mit 3 Stellen/Zeichen

..3

variable Länge mit maximal 3 Stellen/Zeichen

enum

Aufzählung erlaubter Werte

dttm

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


Abkürzungen:

AbkürzungBeschreibungKommentar

CND

Bedingung (condition)


M

Pflicht (mandatory)

Wenn ein Parameter Pflicht ist, dann muss er vorhanden sein

O

optional

Wenn ein Parameter optional ist, dann kann er vorhanden sein, ist aber nicht erforderlich

C

bedingt (conditional)

Wenn ein Parameter bedingt ist, dann gibt es eine Bedingungsregel, die angibt, ob er Pflicht oder optional ist


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


Abonnements ändern

Aufruf der Schnittstelle

Das Computop Paygate kann Ihre Abonnements verwalten und regelmäßige Zahlungen für Sie ausführen. Das automatische Anlegen eines Abonnements ist nur zusammen mit Kreditkartenzahlung möglich.

Um ein bestehendes Abonnement über eine Server-zu-Server-Verbindung zu ändern, 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:

Parameter

Format

CND

Beschreibung

MerchantID

ans..30

M

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

AboID

ans..32

M

Vom Paygate vergebene ID für das Abo

Amount

n..12

O

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

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

OrderDesc

ans..768

O

Beschreibung der gekauften Waren, Einzelpreise etc.

MAC

an64

M

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

AboAction

a..10

M

Aktion. Beim Ändern immer <Update>

StartDate

n8

M

Startdatum des Abos im Format YYYYMMDD

EndDate

n8

M

Enddatum des Abos im Format YYYYMMDD

Interval

n..3

M

Abstand zur nächsten Abo-Zahlung in Tagen: 1=täglich, 7=wöchentlich, 30=monatlich, 90=vierteljährlich, 180=halbjährlich, 360=jährlich

Active

a..5

O

Der Wert <true> aktiviert das Abo. Der Wert <false> deaktiviert das Abo.

Parameter zum Ändern von Abonnements über Socket-Verbindungen


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

Parameter

Format

CND

Beschreibung

AboID

ans..32

M

Vom Paygate vergebene ID für das Abo

Status

a..50

M

OK oder FAILED

Description

ans..1024

M

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

Code

n8

M

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

MAC

an64

M

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

Antwort-Parameter beim Ändern von Abonnements über Socket-Verbindungen

  • No labels