EPayment [ccb by dsb®

Dies beschreibt die Epayment REST Web Services. Diese Services können nur in Absprache mit dem Kundenberater und entsprechender Konfiguration im Backend genutzt werden.

Notify 1.0

Path mapping(intern): /net/dsb/commons/EPayment/notify-1.0.0

URL

POST: /rest/{client}/epayment/notify

Parameter	Beschreibung
client	Mandanten ID
sp	Dienstleisterkennung. (Pflichtfeld, falls der User mehrere verschiedene Kennungen nutzen kann.)
so	VkOrg. (Pflichtfeld, falls der Benutzeraccount nur spezielle VkOrgs des Mandanten nutzen darf.)

Zur Zeit werden nur Cybersource, Wirecard und PayPal unterstützt.

Entsprechender SOAP Service: notifyCardTransactionWithCybersource, notifyTrxPaypal, notifyTrx.

Request Body

Der Body des Post Requests enthält ein JSON Dokument mit den Notify Daten.

JSON EPayment Notify

Beispiel

{
    "paymentProvider" : "CYSC",
    "notifyType" : "REGISTER-PAYMENT",
    "merchantId" : "fplgbpweb",
    "merchantReferenceCode" : "e7b716aada75ba45f7020db578e425e5",
    "amount" : 55.00,
    "currency" : "GBP",
    "billTo" : {
        "firstName" : "Paul",
        "lastName"  : "Master",
        "street1"   : "Hauptstr.",
        "city"      : "Hamburg",
        "postalCode" : "22359",
        "countryCode" : "DE",
        "email"     : "paul@gmail.com",
        "id"        : "paypal-id"
    },
    "cardDetails" : {
        "cardNumber" : "12345678901234567890",
        "cardType"   : "VISA",
        "cardExpiry" : "2020-05"
    },
    "externalTransactionId" : "4869184370256047504057",
    "requestToken" : "Ahj//wSTB/WB6rQTz/q5AhTRi4cuWrduzZqI3DLxw8AVExaZSuo50Nq+NwcMmkmVdHpKyyhg9kwf1gSgy+xYuhAA+ARR",
    "reconciliationID" : "4189957733",
    "recurringPayID" : "4869184156396326104708",
    "requestTimestamp" : "2018-02-12T16:53:57Z",
    "paymentParts" : [ 
    {
        "client" : "123",
        "amount" : 45.00
    },
    {
        "client" : "1234",
        "amount" : 10.00
    }
    ]
}

Element Definitionen

Name	Typ	Pflicht?	Beschreibung
paymentProvider	C	X	Zahlungsdienstleister: Liste der Zahlungsdienstleister
notifyType	C	X	Typ: Notify Typen
merchantId	C	X	ID des Händlers beim Dienstleister
merchantReferenceCode	C	X	Referenznummer der Transaktion beim Händler.
amount	N		Zahlungsbetrag
currency	C		Währung (ISO Code)
billTo			Rechnungsempfänger / Zahler
cardDetails			Kreditkartendetails (bei Kreditkartentransaktionen)
cardDetails.cardNumber	C	X	Kredikartennummer (maskiert)
cardDetails.cardType	C	X	Kartentyp; entweder der cc-company-code oder der Codewert des jeweiligen Dienstleisters. (Cybersource Codes)
cardDetails.cardExpiry	C	X	Ablaufmonat (Format: yyyy-mm)
externalTransactionId	C	X	Referenznummer der Transaction beim Zahlungsdienstleister.
requestToken	C		Token beim Zahlungsdienstleister. (nur Cybersource)
reconciliationID	C	X	ID zur Reconciliation
recurringPayID	C		ID für wiederkehrende Zahlungen
requestTimestamp	TS	X	Zeitpunkt der Zahlung
paymentParts			Teile der Transaktion falls diese auf mehrere Mandanten aufgesplittet wird.
paymentParts.client	C	X	Mandanten ID
paymentParts.amount	N	X	Betrag für diesen Mandanten. Die Summe aller Teile muss den Gesamtbetrag des Requests ergeben.

Der Service liefert eine Liste mit Transaktions IDs, eine ID pro im Request enthaltenem Payment Part.

Notify 2.0

Path mapping(intern): /net/dsb/commons/FlyPayment/notify-1.0.0

URL

POST: /rest/{client}/payments PUT: /rest/{client}/payments/{guid}

Parameter	Beschreibung
client	Mandanten ID
sp	Dienstleisterkennung. (Pflichtfeld, falls der User mehrere verschiedene Kennungen nutzen kann.)
so	VkOrg. (Pflichtfeld, falls der Benutzeraccount nur spezielle VkOrgs des Mandanten nutzen darf.)
guid	eindeutige ID für diese Zahlungsdaten. In der Variante ohne diesen Parameter wird vom System eine ID generiert.

Der Body des Post Requests enthält ein JSON Dokument mit den Notify Daten.

Als Response liefert dieser Service eine Transaktions IDs die die Zahlungsdatendaten referenziert und bei nachfolgenden Requests (create subscription, change payment, …) verwendet wird.

Get Notify

Path mapping(intern): /net/dsb/commons/FlyPayment/getNotify-1.0.0

URL

GET: /rest/{client}/payments/{guid}

Parameter	Beschreibung
client	Mandanten ID
sp	Dienstleisterkennung. (Pflichtfeld, falls der User mehrere verschiedene Kennungen nutzen kann.)
so	VkOrg. (Pflichtfeld, falls der Benutzeraccount nur spezielle VkOrgs des Mandanten nutzen darf.)
guid	eindeutige ID für diese Zahlungsdaten.

Dieser Service liefert die bei einem vorherigen Notify übertragenen Daten anhand der dort generierten ID. Dies ist ein interner Service. Kundenaccounts können diesen nicht nutzen.

Create Fly Payment Widget Link

Path mapping(intern): /net/dsb/commons/FlyPayment/createFlyPaymentLink-1.0.0

URL

GET: rest/{client}/subscriptions/{orderNumber}/flyPayLink

Dieser Webservice kann für 2 Szenarios genutzt werden:

1. Payment Widget Link zur Zahlwegsänderung erzeugen

Wenn sendMessage gesetzt ist, wird ein Brief mit dem Link verschickt. Ansonsten wird der Link im Response zurückgegeben. Vor Verwendung bitte mit dsb abklären, ob Briefe vorhanden sind und die Funktionalität genutzt werden kann.

2. Payment Widget Link zur Erneuerung eines Renewal-Abos erzeugen

Sobald ein Kunde über den erzeugen Link eine Zahlung tätigt wird das entsprechende Abo in SAP erneuert. Der angebotene Preis ergibt sich aus dem zur Erzeugung genutzten Angebot und der Bestellquelle.

Parameter	Beschreibung	Zahlwegsänderung (1)	Erneuerung (2)
client	Mandanten ID	X	X
orderNumber	Abo Auftragsnummer	X	X
sp	Dienstleisterkennung. (Pflichtfeld, falls der User mehrere verschiedene Kennungen nutzen kann.)	X	X
so	VkOrg. (Pflichtfeld, falls der Benutzeraccount nur spezielle VkOrgs des Mandanten nutzen darf.)	X	X
sendMessage	(true/false): soll eine Nachricht versandt werden? (default: false)	X
offerCode	Angebotscode		X (mandatory)
sourceCodeVariant	BQ-Variante		X (obligatory)
sourceCode	BQ		X (mandatory)
externalOrderNumber	Externe Auftragsnummer die zur Erneuerung genutzt wird. Optional. Wird automatisch generiert falls nicht angegeben		X
compressBundle	Bundles als eine Position darstellen (default false)		X
amount	Zahlbetrag
billingAgreement	Registrierung Zahlart? (true/false default: false - Zahlung sofort )

Rückgabestruktur:

{
    "status": "OK",
    "code": 0,
    "message": "<URL>"
}

Fehlercode	Beschreibung
10*	Fehlerhafte Eingabedaten
20*	Fehler bei Linkgenerierung
30*	Fehler bei Nachrichtenanlage
40*	Error renewal link creation