Allgemein
In dieser Seite werden alle API-Calls rund um die SEPA-Mandate beschrieben.
Hinweis: Datums Felder im "data" Teil haben das Format "YYYYMMDDhhmmss".
Inhaltsverzeichnis
getSepaData
Liefert die Informationen zu einem SepaMandat
Aufruf
-
GET - api/sepa/getSepaDaten?v=1 -
http://trademan/api/sepa/getSepaDaten?v=1
Eingebundene Parameter aus Parametertabelle
LETZTESEPANUMMER → Letzte verwendete Sepanummer, wird vor Einzug hochgezählt.
EIGENERNAME → Empfängername des Unternehmens, das die Rechnung erfasst
EIGENERNAME2 → Empfängername des Unternehmens, das den Inkasso initiiert
EIGENEIBAN → IBAN des Empfängerunternehmens
EIGENEBIC → BIC des Empfängerunternehmens
EIGENESEPAGLAEUBIGERID → GläubigerID des Empfängerunternehmens
Antwort
Beim erfolgreichen Aufruf kommen die Infos zu einem SepaMandat zurück
-
200 - OK
-
404 - Daten nicht gefunden
-
500 - Unbekannter Fehler
{
"success": true,
"code": 200,
"api_version": "1",
"rowcount": 2,
"msg": "Der Zahlungsauftrag wurde versendet.",
"warning": "",
"data":[
"PD94bWwgdmVyc2lvbj0iMS4wIj8+CjxEb2N1bWVudCB4bWxuczp4c2k9Imh0dHA6Ly93d3cudzMub3JnLzIwMDEvWE1MU2NoZW1hLWluc3RhbmNlIiB4bWxucz0idXJuOmlzbzpzdGQ6aXNvOjIwMDIyOnRlY2g6eHNkOnBhaW4uMDA4LjAwMi4wMiIgeHNpOnNjaGVtYUxvY2F0aW9uPSJ1cm46aXNvOnN0ZDppc286MjAwMjI6dGVjaDp4c2Q6cGFpbi4wMDguMDAyLjAyIHBhaW4uMDA4LjAwMi4wMi54c2QiPjxDc3RtckRyY3REYnRJbml0bj48R3JwSGRyPjxNc2dJZD4xOTQ8L01zZ0lkPjxDcmVEdFRtPjIwMTktMDktMTJUMTQ6NDM6NDkuMDAwMDAwPC9DcmVEdFRtPjxOYk9mVHhzPjE8L05iT2ZUeHM+PEN0cmxTdW0+MjQuNTwvQ3RybFN1bT48SW5pdGdQdHk+PE5tLz48L0luaXRnUHR5PjwvR3JwSGRyPjxQbXRJbmY+PFBtdEluZklkPjE5NDwvUG10SW5mSWQ+PE5iT2ZUeHM+MTwvTmJPZlR4cz48Q3RybFN1bT4yNC41PC9DdHJsU3VtPjxQbXRUcEluZj48U3ZjTHZsPjxDZD5TRVBBPC9DZD48L1N2Y0x2bD48TGNsSW5zdHJtPjxDZD5DT1JFPC9DZD48L0xjbEluc3RybT48U2VxVHA+UkNVUjwvU2VxVHA+PC9QbXRUcEluZj48UmVxZENvbGx0bkR0PjIwMTktMDktMDY8L1JlcWRDb2xsdG5EdD48Q2R0cj48Tm0+cG9lIEdtYkggJmFtcDsgQ28gS0c8L05tPjwvQ2R0cj48Q2R0ckFjY3Q+PElkPjxJQkFOPkRFMTI0NzY1MDEzMDEyMzQ1Njc4OTA8L0lCQU4+PC9JZD48Y2N5PkVVUjwvY2N5PjwvQ2R0ckFjY3Q+PENkdHJBZ3Q+PEZpbkluc3RuSWQ+PEJJQz5XRUxBREUzTFhYWDwvQklDPjwvRmluSW5zdG5JZD48L0NkdHJBZ3Q+PENkdHJTY2htZUlkPjxJZD48UHJ2dElkPjxPdGhyPjxJZD5ERTExWlpaMTIzNDU2NzQ4OTwvSWQ+PFNjaG1lTm0+PFBydHJ5PlNFUEE8L1BydHJ5PjwvU2NobWVObT48L090aHI+PC9QcnZ0SWQ+PC9JZD48L0NkdHJTY2htZUlkPjxEcmN0RGJ0VHhJbmY+PFBtdElkPjxFbmRUb0VuZElkPjEzODg8L0VuZFRvRW5kSWQ+PC9QbXRJZD48SW5zdGRBbXQgY2N5PSJFVVIiPjI0LjU8L0luc3RkQW10PjxEcmN0RGJ0VHg+PE1uZHRSbHRkSW5mPjxNbmR0SWQ+MDAwMTEwMDMwMjAxOTA4MDAxPC9NbmR0SWQ+PER0T2ZTZ250cj4yMDE5LTA5LTEyPC9EdE9mU2dudHI+PEFtZG1udEluZC8+PC9NbmR0Umx0ZEluZj48L0RyY3REYnRUeD48RGJ0ckFndD48RmluSW5zdG5JZD48QklDPmRmc3czc2RmNHdlPC9CSUM+PC9GaW5JbnN0bklkPjwvRGJ0ckFndD48RGJ0cj48Tm0+QmFuazwvTm0+PC9EYnRyPjxEYnRyQWNjdD48SWQ+PElCQU4+ZGUxMjM0NTY3ODkwMjM0PC9JQkFOPjwvSWQ+PC9EYnRyQWNjdD48Um10SW5mPjxVc3RyZD5UTlIgODggVk9NIDA1LjA5LjIwMTk8L1VzdHJkPjwvUm10SW5mPjwvRHJjdERidFR4SW5mPjwvUG10SW5mPjwvQ3N0bXJEcmN0RGJ0SW5pdG4+PC9Eb2N1bWVudD4K",
"PD94bWwgdmVyc2lvbj0iMS4wIj8+CjxEb2N1bWVudCB4bWxuczp4c2k9Imh0dHA6Ly93d3cudzMub3JnLzIwMDEvWE1MU2NoZW1hLWluc3RhbmNlIiB4bWxucz0idXJuOmlzbzpzdGQ6aXNvOjIwMDIyOnRlY2g6eHNkOnBhaW4uMDA4LjAwMi4wMiIgeHNpOnNjaGVtYUxvY2F0aW9uPSJ1cm46aXNvOnN0ZDppc286MjAwMjI6dGVjaDp4c2Q6cGFpbi4wMDguMDAyLjAyIHBhaW4uMDA4LjAwMi4wMi54c2QiPjxDc3RtckRyY3REYnRJbml0bj48R3JwSGRyPjxNc2dJZD4xOTU8L01zZ0lkPjxDcmVEdFRtPjIwMTktMDktMTJUMTQ6NDM6NDkuMDAwMDAwPC9DcmVEdFRtPjxOYk9mVHhzPjE8L05iT2ZUeHM+PEN0cmxTdW0+MjA8L0N0cmxTdW0+PEluaXRnUHR5PjxObS8+PC9Jbml0Z1B0eT48L0dycEhkcj48UG10SW5mPjxQbXRJbmZJZD4xOTU8L1BtdEluZklkPjxOYk9mVHhzPjE8L05iT2ZUeHM+PEN0cmxTdW0+MjA8L0N0cmxTdW0+PFBtdFRwSW5mPjxTdmNMdmw+PENkPlNFUEE8L0NkPjwvU3ZjTHZsPjxMY2xJbnN0cm0+PENkPkNPUkU8L0NkPjwvTGNsSW5zdHJtPjxTZXFUcD5SQ1VSPC9TZXFUcD48L1BtdFRwSW5mPjxSZXFkQ29sbHRuRHQ+MjAxOS0wOS0wNjwvUmVxZENvbGx0bkR0PjxDZHRyPjxObT5wb2UgR21iSCAmYW1wOyBDbyBLRzwvTm0+PC9DZHRyPjxDZHRyQWNjdD48SWQ+PElCQU4+REUxMjQ3NjUwMTMwMTIzNDU2Nzg5MDwvSUJBTj48L0lkPjxjY3k+RVVSPC9jY3k+PC9DZHRyQWNjdD48Q2R0ckFndD48RmluSW5zdG5JZD48QklDPldFTEFERTNMWFhYPC9CSUM+PC9GaW5JbnN0bklkPjwvQ2R0ckFndD48Q2R0clNjaG1lSWQ+PElkPjxQcnZ0SWQ+PE90aHI+PElkPkRFMTFaWloxMjM0NTY3NDg5PC9JZD48U2NobWVObT48UHJ0cnk+U0VQQTwvUHJ0cnk+PC9TY2htZU5tPjwvT3Rocj48L1BydnRJZD48L0lkPjwvQ2R0clNjaG1lSWQ+PERyY3REYnRUeEluZj48UG10SWQ+PEVuZFRvRW5kSWQ+MTM4OTwvRW5kVG9FbmRJZD48L1BtdElkPjxJbnN0ZEFtdCBjY3k9IkVVUiI+MjA8L0luc3RkQW10PjxEcmN0RGJ0VHg+PE1uZHRSbHRkSW5mPjxNbmR0SWQ+MDAwMTEwMDMwMjAxOTA4MDAxPC9NbmR0SWQ+PER0T2ZTZ250cj4yMDE5LTA5LTEyPC9EdE9mU2dudHI+PEFtZG1udEluZC8+PC9NbmR0Umx0ZEluZj48L0RyY3REYnRUeD48RGJ0ckFndD48RmluSW5zdG5JZD48QklDPmRmc3czc2RmNHdlPC9CSUM+PC9GaW5JbnN0bklkPjwvRGJ0ckFndD48RGJ0cj48Tm0+QmFuazwvTm0+PC9EYnRyPjxEYnRyQWNjdD48SWQ+PElCQU4+ZGUxMjM0NTY3ODkwMjM0PC9JQkFOPjwvSWQ+PC9EYnRyQWNjdD48Um10SW5mPjxVc3RyZD5UTlIgODkgVk9NIDA1LjA5LjIwMTk8L1VzdHJkPjwvUm10SW5mPjwvRHJjdERidFR4SW5mPjwvUG10SW5mPjwvQ3N0bXJEcmN0RGJ0SW5pdG4+PC9Eb2N1bWVudD4K"
]
}
Aufruf
-
GET - api/sepa/getmandat?v=1&mitgliedsnummer={nr}&umr={umrnr} -
http://trademan/api/sepa/getmandat?v=1&mitgliedsnummer=1&umr=0000120200624001
Aufruf Parameter
Mitgliedsnummer →Die Mitgliedsnummer (Kundennummer)
UMR → Die UMR
Antwort
Beim erfolgreichen Aufruf kommen die Infos zu einem SepaMandat zurück
-
200 - OK
-
404 - Daten nicht gefunden
-
500 - Unbekannter Fehler
[
{
"UMR": "0000120200624001",
"IBAN": "DE41500105170123456789",
"BIC": "AAAAAAAAXXX",
"Dienstsiegel": null,
"KreditinstitutName": "BankName",
"DatumUnterschrift": "20200624000000",
"DatumAnlage": "20200624000000",
"Herkunft": "Frankfurt am Main",
"Mitgliedsnummer": "1",
"AbweichenderKontoInhaber": {
"AnredeID": null,
"Anrede": null,
"Vorname": null,
"Nachname": null,
"AdressZusatz": null,
"StrasseNr": null,
"PLZ": null,
"Ort": null
},
"Aktiv": true,
"InaktivierungsGrundID": 0,
"InaktivierungsGrundBezeichung": null,
"Wiederkehrend": false
}
]
Aufruf
-
POST - api/sepa/setmandat -
http://trademan/api/sepa/setmandat
Request
{
"api_version": 1,
"systemno": 4711,
"operatorno": 789,
"systemtype": "POSMAN",
"processno": 0,
"datetime": "2019-02-21T12:20:50+0100",
"data":
{
"mandat": {
"AbweichenderKontoInhaber" : {
"Anrede" : null,
"Nachname" : null,
"Vorname" : null,
"PLZ" : null,
"AdressZusatz" : null,
"Ort" : null,
"StrasseNr" : null
},
"UMR" : 999,
"DatumUnterschrift" : "20200624000000",
"IBAN" : "DE41500105170123456789",
"BIC" : "AAAAAAAAXXX",
"KreditinstitutName" : "BankName",
"DatumAnlage" : "20200624000000",
"Herkunft" : "Frankfurt am Main",
"Mitgliedsnummer" : "1",
"Aktiv" : true,
"InaktivierungsGrundBezeichnung" : "",
"InaktivierungsGrundID" : "",
"Wiederkehrend" : "0"
}
}
}
Antwort
Beim erfolgreichen Aufruf kommen die Infos zu einem SepaMandat zurück
-
200 - OK
-
404 - Daten nicht gefunden
-
500 - Unbekannter Fehler
{
"api_version": 1,
"success": true,
"msg": "Erfolg: Das Mandat wurde erfolgreich angelegt.",
"warning": "",
"data": []
}
Aufruf
-
GET - api/sepa/getgeschaeftsstellendaten/{dienstsiegel}?v=1 -
http://trademan/api/sepa/getgeschaeftsstellendaten/1?v=1
Aufruf Parameter
Dienstsiegel → Das Dienstsiegel
Antwort
Beim erfolgreichen Aufruf kommen die Infos zu einer Geschäftsstelle zurück
-
200 - OK
-
404 - Daten nicht gefunden
-
500 - Unbekannter Fehler
{
"GlaeubigerIdentNr": "",
"LsDerGsErlaubt": false,
"StateCountry": "Deutschland",
"StoreState": null,
"VatRegistrationNumber": "",
"StoreName": "Erste Filiale",
"StoreAddress1": "Filialstrasse",
"StoreAddress2": null,
"StoreCity": "Paderborn",
"StoreZip": "33102",
"StorePhone": "",
"StoreFax": "",
"StoreEmail": "",
"VATDetailID": null,
"IBAN": "",
"BIC": "",
"BS_PayplaceIsActive": null,
"BS_MerchantID": null,
"BS_Url": null
}
Herkunft der Daten von getGeschaeftsstellenDaten
|
Feld |
Herkunft |
|---|---|
|
GlaeubigerIdentNr |
Parameter EIGENESEPAGLAEUBIGERID |
|
LsDerGsErlaubt |
Addinfo 26 an Filiale |
|
StateCountry |
Filialadresse Land |
|
StoreState |
- |
|
VatRegistrationNumber |
Parameter EIGENEUSTID |
|
StoreName |
Adressbezeichnung - Filialbezeichnung |
|
StoreAddress1 |
Filialadresse Straße |
|
StoreAddress2 |
- |
|
StoreCity |
Filialadresse Ort |
|
StoreZip |
Filialadresse Plz |
|
StorePhone |
Filialadresse Telefon |
|
StoreFax |
Filialadresse Telefax |
|
StoreEmail |
Filialadresse Email |
|
VATDetailID |
- |
|
IBAN |
Parameter EIGENEIBAN |
|
BIC |
Parameter EIGENEBIC |
|
BS_PayplaceIsActive |
- |
|
BS_MerchantID |
- |
|
BS_Url |
- |