API (Zahlungen)

Um ein beliebiges Zahlungssystem an PayJoe anzubinden, können Sie die API-Zahlungsschnittstelle nutzen.

API-Zahlungszugang in PayJoe anlegen

1. PayJoe öffnen.

2. Neuen Zugang anlegen:

a. Zahlungsabgleich wählen.

b. Das Plus-Symbol rechts unten in der Hauptansicht anklicken:

zugang_hinzufuegen_lupe
zugang_hinzufuegen_lupe

Die Seite Zugänge > Neu wird geöffnet:

zugang_hinzufuegen_neu
zugang_hinzufuegen_neu

3. Der Schritt-für-Schritt-Eingabe folgen und dabei folgende Daten eingeben:

  • Zahlungszugang: API (Zahlungen)

4. Bestätigen Sie Ihre Auswahl mit Weiter.

5. Der Schritt-für-Schritt-Eingabe weiter folgen, bis Sie den Zugang erfolgreich erstellt haben.

  • 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).

6. API-Zugangsdaten und folgende Informationen für Entwickler an Ihren Entwickler weitergeben.

Informationen für Entwickler

Upload von Zahlungen

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

string APIKey

int ZugangID

PayJoeZahlung [] Zahlungen

// m - 100

// m - 100

// m

// 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 Zahlungsdatensatz (PayJoeZahlung) übertragen werden:

int BerichtID

string UniqueIdentifier

DateTime Buchungsdatum

DateTime BerichtEndedatum

DateTime BerichtDepositdatum

DateTime Valutadatum

Waehrung Waehrung

double NettoBetrag

Waehrung NettoWaehrung

double BruttoBetrag

Waehrung BruttoWaehrung

double GebuehrBetrag

Waehrung GebuehrWaehrung

string BankleitzahlZahlender

string BIC

string KontonummerZahlender

string IBAN

string NameZahlender1

string NameZahlender2

string Belegnummer

string Bestellnummer

string TransaktionsID

string Kundennummer

string Referenz1

string Referenz2

string Referenz3

string Referenz4

string Marktplatz

ZahlungsStatus Zahlungsstatus

string Zahlungstyp

bool NichtSaldorelevant

string Buchungstext

// o

// o - 80

// m

// o

// o

// m

// m

// o

// o

// m

// m

// o

// o

// o - 10

// o - 11

// o - 20

// o - 34

// o - 100

// o - 100

// o - 30

// o - 30

// o - 100

// o - 30

// o - 50

// o - 50

// o - 50

// o - 50

// o - 50

// o

// o - 50

// o

// 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 eine Zahlung wie folgt aus:

{

"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 LetztesZahlungsdatum enthält das neueste Datum einer Zahlung, das in der Datenbank abgelegt ist. Auf diese Art können Sie den Upload in kleinere Pakete zerteilen. Es wird empfohlen nicht mehr als 500 Belege mit einem Aufruf zu übertragen.

bool Erfolgreich

DateTime LetztesZahlungsdatum

Hier der Inhalt der Antwort bei erfolgreichem Zahlungs-Upload:

{

"Erfolgreich":true,

"LetztesZahlungsdatum":"2018-01-07T14:50:55.26"

}