API (Zahlungen)
Um ein beliebiges Zahlungssystem an PayJoe anzubinden, können Sie die API-Zahlungsschnittstelle nutzen.
-
PayJoe öffnen.
-
Der Schritt-für-Schritt-Eingabe folgen und dabei folgende Daten eingeben:
- Zahlungszugang: API_Zahlungen
-
Der Schritt-für-Schritt-Eingabe weiter folgen, bis Sie den Zugang erfolgreich erstellt haben.
Hinweise
- Bevor die Daten an PayJoe übermittelt werden können, muss Ihr Entwickler sie in die geeignete Form bringen und via API an PayJoe übermitteln.
- Ihr Entwickler benötigt dafür u.a. die API-Zugangsdaten. Diese können Sie auch nachträglich in PayJoe einsehen (siehe "Zugangsdaten einsehen").
- API-Zugangsdaten und folgende Informationen für Entwickler an Ihren Entwickler weitergeben.
- URL für POST-Request: https://api.payjoe.de/zahlungsupload
- Content-Type: JSON
- Tag im Header: Content-Type: application/json
Upload von Zahlungen
Hinweis
Die Information, ob ein Feld zwingend benötigt wird (m = muss / o = optional) und die maximale Länge der String-Inhalte stehen jeweils als Kommentar hinter den Feldern.
Jeweils eines der folgende Objekte muss im Body des Requests enthalten sein:
string UserName |
// m - 100 |
string APIKey |
// m - 100 |
int ZugangID |
// m |
PayJoeZahlung[] |
// m |
Darin sind die oben genannten Zugangsdaten zu setzen sowie ein Array von PayJoeZahlung -Objekten zu übermitteln.
Feldinformationen PayJoe Zahlungen
Folgende Felder können in einem PayJoe
int BerichtID |
// o |
string UniqueIdentifier |
// o - 80 |
DateTime Buchungsdatum |
// m |
DateTime BerichtEndedatum |
// o |
DateTime BerichtDepositdatum |
// o |
DateTime Valutadatum |
// m |
Waehrung Waehrung |
// m |
double NettoBetrag |
// o |
Waehrung NettoWaehrung |
// o |
double BruttoBetrag |
// m |
Waehrung BruttoWaehrung |
// m |
double GebuehrBetrag |
// o |
Waehrung GebuehrWaehrung |
// o |
string BankleitzahlZahlender |
// o - 10 |
string BIC |
// o - 11 |
string KontonummerZahlender |
// o - 20 |
string IBAN |
// o - 34 |
string NameZahlender1 |
// o - 100 |
string NameZahlender2 |
// o - 100 |
string Belegnummer |
// o - 30 |
string Bestellnummer |
// o - 30 |
string TransaktionsID |
// o - 100 |
string Kundennummer |
// o - 30 |
string Referenz1 |
// o - 50 |
string Referenz2 |
// o - 50 |
string Referenz3 |
// o - 50 |
string Referenz4 |
// o - 50 |
string Marktplatz |
// o - 50 |
ZahlungsStatus Zahlungsstatus |
// o |
string Zahlungstyp |
// o - 50 |
bool NichtSaldorelevant |
// o |
string Buchungstext |
// o - 50 |
Dabei steht Zahlungsstatus = 0 für unbekannt und Zahlungsstatus = 1 für bezahlt.
Als Waehrung wird der internationale numerische Währungs-Code verwendet: Euro ist dabei beispielsweise 978, US-Dollar 840 und das Britische Pfund 826. Es können dafür auch die Abkürzungen wie beispielsweise „EUR“ oder „USD“ übertragen werden. Weitere Informationen zur Waehrung finden Sie hier: https://de.wikipedia.org/wiki/ISO_4217.
JSON-Beispiel Zahlung
Der Inhalt einer JSON-Nachricht sieht dann beispielsweise für
{
"UserName":"kunde@payjoe.de",
"APIKey":"3k5TStP?=k(!w",
"ZugangID":5697,
"Zahlungen":[{
"BerichtID":45,
"UniqueIdentifier":"1T46DG0575BX16SSD",
"Buchungsdatum":"2018-01-05T14:25:55.2426324+01:00",
"BerichtEndedatum":"2018-01-07T14:25:55.2426324+01:00",
"BerichtDepositdatum":"2018-01-09T14:25:55.2426324+01:00",
"Valutadatum":"2018-01-09T14:25:55.2426324+01:00",
"Waehrung":978,
"NettoBetrag":"18.00",
"NettoWaehrung":978,
"BruttoBetrag":"20.00",
"BruttoWaehrung":978,
"GebuehrBetrag":"2.00",
"GebuehrWaehrung":978,
"BankleitzahlZahlender":"50070024",
"BIC":"DEUTDEDBFRA",
"KontonummerZahlender":"0123456789",
"IBAN":"DE5850070024012346789",
"NameZahlender1":"monika.mustermann@gmx.net",
"NameZahlender2":"Monika Mustermann",
"Belegnummer":"6948593",
"Bestellnummer":"BN-654698",
"TransaktionsID":"1T46DG0575BX16SSD",
"Kundennummer":"2014",
"Referenz1":"T-Shirt Doppelpack",
"Referenz2":"aus Angebot 2365",
"Referenz3":null,
"Referenz4":null,
"Marktplatz":"Amazon.fr",
"Zahlungsstatus":1,
"Zahlungstyp":"Payment",
"NichtSaldorelevant":0,
"Buchungstext":"Completed"
}]
}
Erfolgsmeldung
Als Antwort bekommen Sie im Erfolgsfall untenstehende Objekte als JSON zurückgeliefert. Das Feld
bool Erfolgreich
DateTime
Hier der Inhalt der Antwort bei erfolgreichem
{
"Erfolgreich":true,
"LetztesZahlungsdatum":"2018-01-07T14:50:55.26"
}