Dokumentationen
Anleitung Anbindung Händlerinterface v2

easyCredit-RatenkaufTechnische Anbindung des Händlerinterface mithilfe der API

Allgemeine Informationen

Diese Anleitung soll einen Überblick geben, wie die Prozesse, die nach Abschluss eines „easyCredit-Ratenkauf“ möglich sind, über eine Schnittstelle eingebunden werden können.
Die im Folgenden genannten Vorgänge können alle auch manuell über unser Händlerinterface vorgenommen werden.

Autorisierung

Die Nutzung der Händlerinterface-API erfordert eine Anmeldung an unserem System. Die Autorisierung erfolgt analog zur Vorgang-API via Request-Header mit den gleichen Daten wie bei der Webshop-Integration. Die notwendigen Header Felder sind:

Feld	Erläuterung
tbk-rk-shop	Ihre Webshop-ID
tbk-rk-token	Das API-Kennwort, das Sie selbst in der Shopadministration vergeben

Endpoints

Die API besteht aus den Endpoints:

Suchen von Vorgängen/Bestellungen
Lieferung melden
Rückabwicklung durchführen

Base-URL

https://app.easycredit.de/ratenkauf/transaktionsverwaltung-ws/rest/v2/transaktionen

Suchen von Vorgängen/Bestellungen anhand der Vorgangskennung

Request:

GET https://app.easycredit.de/ratenkauf/transaktionsverwaltung-ws/rest/v2/transaktionen/{vorgangskennung}

Request Parameters:

name	type	description	constraints
vorgangskennung	path	die fachliche Vorgangskennung (6 Zeichen) des Vorgangs, der gesucht werden soll

Anwendungsbeispiel:

GET  https://app.easycredit.de/ratenkauf/transaktionsverwaltung-ws/rest/v2/transaktionen/TKCLH5 HTTP/1.1

Header


tbk-rk-shop	Ihre Webshop-ID
tbk-rk-token	Ihr API-Kennwort

Suchen von Vorgängen/Bestellungen anhand von anderen Merkmalen

Request:

GET https://app.easycredit.de/ratenkauf/transaktionsverwaltung-ws/rest/v2/transaktionen/suchen

Request Parameters:

name	type	description	constraints
bis	query	Maximales Bestelldatum. Die Bestelldaten der gesuchten Vorgänge liegen zeitlich vor diesem Datum. (Format: yyyy-MM-dd)
status	query	Status, den die gesuchten Vorgänge besitzen sollen.	"LIEFERUNG_MELDEN" or "LIEFERUNG_MELDEN_AUSLAUFEND" or "ALLE" or "IN_ABRECHNUNG" or "ABGERECHNET" or "AUSLAUFEND"
von	query	Minimales Bestelldatum. Die Bestelldaten der gesuchten Vorgänge liegen zeitlich nach diesem Datum. (Format: yyyy-MM-dd)

Anwendungsbeispiel:

GET  https://app.easycredit.de/ratenkauf/transaktionsverwaltung-ws/rest/v2/transaktionen/suchen?von=2018-01-01&status=LIEFERUNG_MELDEN  HTTP/1.1


tbk-rk-shop	Ihre Webshop-ID
tbk-rk-token	Ihr API-Kennwort

Lieferung melden

Request:

POST https://app.easycredit.de/ratenkauf/transaktionsverwaltung-ws/rest/v2/transaktionen/{vorgangskennung}/lieferung

Request Parameters:

name	type	description	constraints
vorgangskennung	path	die fachliche Vorgangskennung (6 Zeichen) des Vorgangs zu dem die Lieferung gemeldet werden soll.

Anwendungsbeispiel:

POST  https://app.easycredit.de/ratenkauf/transaktionsverwaltung-ws/rest/v2/transaktionen/TKNJCT/lieferung  HTTP/1.1

Header


tbk-rk-shop	Ihre Webshop-ID
tbk-rk-token	Ihr API-Kennwort

Body

{

}

Anmerkung: Es wird immer das jeweils aktuelle Tagesdatum übertragen, unabhängig davon, welches Datum im Request eingetragen ist.

Rückabwicklung durchführen

Request:

POST https://app.easycredit.de/ratenkauf/transaktionsverwaltung-ws/rest/v2/transaktionen/{vorgangskennung}/rueckabwicklung

Request Parameters:

name	type	description	constraints
vorgangskennung	path	die fachliche Vorgangskennung (6 Zeichen) des Vorgangs zu dem die Lieferung gemeldet werden soll.

Anwendungsbeispiel (teilweiser Widerruf):

POST https://app.easycredit.de/ratenkauf/transaktionsverwaltung-ws/rest/v2/transaktionen/TKNJMV/rueckabwicklung  HTTP/1.1

Header


tbk-rk-shop	Ihre Webshop-ID
tbk-rk-token	Ihr API-Kennwort

Body

{
  "datum" : "2017-11-17",
  "grund" : "WIDERRUF_TEILWEISE",
  "betrag" : 500.00
}

Anwendungsbeispiel (vollständiger Widerruf):

POST  https://app.easycredit.de/ratenkauf/transaktionsverwaltung-ws/rest/v2/transaktionen/TKNJMV/rueckabwicklung     HTTP/1.1

Header


tbk-rk-shop	Ihre Webshop-ID
tbk-rk-token	Ihr API-Kennwort

Body

{
  "datum" : "2017-11-17",
  "grund" : "WIDERRUF_VOLLSTAENDIG"
}

Request properties:

name	type	description	constraints
betrag	object
datum	number
grund	ENUM	Grund der Rückabwicklung	"WIDERRUF_VOLLSTAENDIG" or "WIDERRUF_TEILWEISE" or "RUECKGABE_GARANTIE_GEWAEHRLEISTUNG" or "MINDERUNG_GARANTIE_GEWAEHRLEISTUNG"