Stripe (API)

Die Zahlungsdaten von Stripe werden über eine API-Schnittstelle zu PayJoe übertragen. Dafür müssen Sie einmalig in der Oberfläche von PayJoe einen Stripe-Zugang anlegen und diesen laut unserer Anleitung konfigurieren.

Sie sind gerade dabei einen Zugang zum Anbinden von Stripe in PayJoe anzulegen (siehe Zugänge ) oder haben diesen Vorgang bereits abgeschlossen.

Damit PayJoe die Zahlungsdaten von Stripe abrufen kann, müssen der „Token“ aus Stripe und das „Payment Metadaten Feld“ in PayJoe hinterlegt werden.

Einrichtung in Stripe

Damit PayJoe auf die Zahlungsdaten in Stripe zugreifen kann, muss der „API Key“ in Stripe angelegt werden.

1. Melden Sie sich in Stripe an.

2. Klicken Sie links in der Reiterübersicht auf Entwickler/Developers und darin auf API-Schlüssel/API keys.

3. Klicken Sie auf den Button Eingeschränkten Schlüssel erstellen/Create restricted key.

4. Tragen Sie in Schlüsselname/Key name PayJoe ein und vergeben Sie die in der folgenden Tabelle beschriebenen Rechte. Die Bereiche, die in der Tabelle nicht explizit benannt sind, können auf den Standardeinstellungen belassen werden. Schließen Sie die Erstellung mit dem Button Schlüssel erstellen/Create key ab.

RESSOURCENTYP/RESOURCE TYPE

BERECHITGUNGEN/PERMISSIONS

Alle Core-Ressourcen/Core


Saldo/Balance

Lesen/Read

Zahlungen/Charges

Lesen/Read

Endkunden/Customers

Lesen/Read

Auszahlungen/Payouts

Lesen/Read

PaymentIntents/PaymentIntents

Lesen/Read

Alle Abrechnungs-Ressourcen/Billing


Rechnungen/Invoices

Lesen/Read

Diese Rechte erlauben es PayJoe nur lesend auf Ihre Zahlungstransaktionen, Kundeninformationen, Auszahlungsbeträge und Rechnungen zuzugreifen. Änderungen durch PayJoe an Ihrem System sind dadurch ausgeschlossen.

Stripe (API) an PayJoe anbinden

1. Melden Sie sich in Stripe an.

2. Klicken Sie links in der Reiterübersicht auf Entwickler/Developers und darin auf API-Schlüssel/API keys.

3. Klicken Sie in der Zeile des eben vergebenen PayJoe-Schlüssels auf den Button Schlüsseltoken einblenden/ Reveal live key token. Kopieren Sie diesen Token und fügen ihn für Ihren Stripe-Zugang in PayJoe in das Feld Token ein.

In Stripe können „Payment Metadaten“ wie z.B. eine Bestell- oder Rechnungsnummer enthalten sein. Diese können durch PayJoe nicht automatisch erkannt werden und müssen händisch eingetragen werden, damit diese ausgelesen werden können. Diese Metadaten können durch Sie für jede einzelne Zahlung individuell in Stripe angelegt werden. Die Metadaten sind für PayJoe nur relevant, wenn darin Informationen enthalten sind, die für den Abgleich zwischen Zahlung und Beleg dienlich sind. Wenn also ein Metadaten-Feld Informationen enthält, die auch auf Belegseite zu finden sind, wie eine Bestellnummer, eine Rechnungsnummer oder eine sonstige ReferenzID sollten Sie dieses Feld ausfindig machen und in PayJoe hinterlegen.

Sie kommen wie folgt an die Informationen der Metadaten ran:

1. Klicken Sie links in der Reiterübersicht auf Zahlungen/Payments.

2. Klicken Sie die Zahlungen einzeln an, die für PayJoe hilfreiche Metadaten enthalten. Die Information der Metadaten finden Sie im Bereich Metadaten/Metadata.

Screenshot Metadatat Feld Stripe
Screenshot Metadatat Feld Stripe

3. Fügen Sie den Namen eines Metadaten-Feldes in Ihren Stripe-Zugang in PayJoe in das Feld Payment Metadata Feld ein.

4. Geben Sie nun noch ein Startdatum für den Abruf der Zahlungen von Stripe an und bestätigen Sie Ihre Eingaben mit dem Button Weiter.

Überprüfen Sie bitte Ihre vergebenen Rechte in Stripe, wenn folgende Fehlermeldung auftritt:

„The provided key 'rk_live_******************************XXXX' does not have the required permissions for this endpoint on account 'acct_12345678ABCDEFG'. Having the 'rak_customer_read' permission would allow this request to continue.“

Festgelegte Transaktionen im Stripe Sammelkonto

Beim späteren Export Ihrer Daten aus PayJoe werden über das Sammelkonto verschiedene Arten von Transaktionen ausgegeben (z.B. Brutto-, Netto-, Gebührentransaktionen, ...). Die Ausgabe der Bruttotransaktionen können Sie konfigurieren (siehe Ausgabe Sammelkonto). Ob und welche weiteren Transaktionsdaten ausgegeben werden, wird von Stripe festgelegt.

Legen Sie für diese Transaktionen Buchungsvorlagen in Ihrem Buchhaltungssystem an. Dann werden diese Daten automatisch auf das gewünschte Konto gebucht.

Folgende Tabelle gibt Ihnen einen Überblick über die von PayJoe fest vorgegebenen Transaktionen und ihren Verwendungszweck für Stripe.

Art der TransaktionAusgabe
ServicegebührSTRP‑SG‑[Waehrung]
BestellgebührSTRP‑BG‑[Waehrung]-[TransaktionsID]
Auszahlungsbetrag (TotalAmount Transaction)STRP‑AUSZ‑[Waehrung]-[Auszahlungsdatum]

Stripe Gebühren

In der folgenden Tabelle sehen Sie die einzelnen Gebühren, die Stripe zur Verfügung stellt. Da die Originalbezeichnungen der Gebühren zu viele Zeichen enthalten, gibt PayJoe immer die Abkürzungen im Verwendungszweck mit aus.

GebührAbkürzung
adjustmentDJSTMNT
network_costNTWRKCST
payout_cancelPYTCNCL
payout_failurePYTFLR
stripe_feeSTRPF
SUBSCRIPTIONFEESBSCRPTN
reserve_transactionRSRVTRNS
topuptopup
transfertransfer
transfer_refundTRNSFRRF