Abgleichen und Bereitstellen von BerichtenÖffentliche Vorschau
Erfahren Sie, wie Sie Capital-Berichte für Ihre verbundenen Konten bereitstellen und Capital-Transaktionen in bestehenden Berichten abgleichen können.
Öffentliche Vorschau
Capital für Plattformen ist in der öffentlichen Vorschau verfügbar. Registrieren Sie sich, um beizutreten.
Verwenden Sie diesen Leitfaden für folgende Zwecke:
- Bereitstellung von Capital-Berichten: Stellen Sie Ihren verbundenen Konten Berichte zu Capital-Transaktionen zur Verfügung. Sie können diese Berichte nutzen, um ihre ausstehende Guthaben, ihren Zahlungsverlauf und andere Daten wie ihre Finanzierungsvereinbarung einzusehen. Sie können Ihren verbundenen Konten auf verschiedene Weise Berichte zur Verfügung stellen.
- Bestehende Berichte neu abgleichen, um Capital-Transaktionen einzubeziehen: Wenn Sie in der Nutzeroberfläche Ihrer Plattform bereits Berichte für Ihre verbundenen Konten bereitstellen, können Sie die Stripe APIs verwenden, um die Capital-Transaktionsdaten in diesen bestehenden Berichten zu synchronisieren.
Bei Finanzierungsangeboten gibt es drei Arten von Transaktionen: eine Auszahlung, eine Anzahlung und eine Stornierung. Wenn Sie Berichte mit Hilfe der Stripe-APIs erstellen möchten, beschreiben wir diese Transaktionen weiter unten ausführlicher.
Optionen zum Bereitstellen von Berichten
Sie können Ihren verbundenen Konten Capital-Berichte auf verschiedene Weise zur Verfügung stellen und dabei können mehr als eine Option verwenden:
Verbundene Konten werden per E-Mail über die Annahme des Angebots, die Auszahlung und den wöchentlichen Zahlungsfortschritt benachrichtigt. Diese Co-Branding-E-Mails enthalten einen Link, der ein verbundenes Konto auf eine separate, von Stripe gehostete Capital-Seite weiterleitet, auf der Sie Ihre Capital-Transaktionen und den Zahlungsfortschritt einsehen können. Diese Seite enthält keine Standardinformationen zur Zahlungsabwicklung (wie z. B. ursprüngliche Gebührenbeträge, Plattform- und Verarbeitungsgebühren, Rückerstattungen oder angefochtene Zahlungen). Wir erledigen dies automatisch für Sie (wenn Sie sich beim Onboarding dafür entscheiden, dass Stripe E-Mails in Ihrem Namen sendet). | |
Eingebettete Komponente | Binden Sie die Capital-Finanzierungskomponente in die Nutzeroberfläche Ihrer Plattform ein. Auf diese Weise können Sie Transaktionsberichte anzeigen, auf die Ihre verbundenen Konten direkt über die Nutzeroberfläche Ihrer Plattform zugreifen können. Die Komponente enthält keine Standardinformationen zur Zahlungsabwicklung (wie Gebühren, Rückerstattungen oder angefochtene Zahlungen). Um diese Komponente zu implementieren, siehe Capital-Finanzierung. |
API | Überwachen und zeigen Sie Capital-Transaktionen zusammen mit detaillierten Zahlungsdaten (einschließlich Standardinformationen zur Zahlungsabwicklung wie Gebühren, Erstattungen und Streitfälle) mit der API für Finanzierungstransaktionen an. Sie können auch Ihre eigenen nutzerdefinierten Berichtsschnittstellen erstellen. Um diese APIs zu verwenden, lesen Sie in diesem Leitfaden weiter. |
Sie können auch Ad-hoc-Berichte bereitstellen.
Bevor Sie beginnen
Wenn Sie Berichte über APIs erstellen möchten, sollten Sie sich die folgenden Arten von Transaktionen prüfen:
| Auszahlung | Stripe (mit unserem Finanzpartner) verteilt automatisch Gelder für eine Auszahlung (für ein genehmigtes und akzeptiertes Finanzierungsangebot) gemäß den Bedingungen der Finanzierungsvereinbarung an ein verbundenes Konto. Die Auszahlung einer Capital-Finanzierung ist unabhängig von den regelmäßigen Auszahlungen des verbundenen Kontos. Ihre Plattform muss nichts weiter tun, um diese Auszahlungen zu ermöglichen. |
Anzahlung | Eine Zahlung, die zur Begleichung eines finanzierten Betrags verwendet wird. Es sind drei Arten von Anzahlungstransaktionen verfügbar:
Der Capital-Einbehalt erfolgt gleichzeitig mit der Zahlungsabwicklung, während die Connect-Volumengebühren und die Gebühren für die Plattform-App auf der Grundlage des vollen Zahlungsbetrags berechnet werden. Der endgültige Betrag, der auf ein verbundenes Konto überwiesen wird, ist die ursprüngliche Zahlung abzüglich der Gebühren für die Plattform-App und des Capital-Einbehalts. Zum Beispiel akzeptiert Ihr verbundenes Konto ein Finanzierungsangebot mit einer Einzugsrate von 15 %. Wenn sie fünf Zahlungen von 100 USD an einem Tag annehmen, beträgt ihre Gesamtauszahlung nach Abzug der Gebühren für Ihre Plattform-App und des Capital-Einbehalts 405 USD. |
Storno | Stripe kann eine Auszahlungs- oder Anzahlungstransaktion in den folgenden Situationen zurückbuchen:
|
Sie können Transaktionen entweder über die API für Finanzierungstransaktionen oder für Saldo-Transaktionen abrufen.
Wählen Sie eine API, um loszulegen:
Verwenden Sie die API für Finanzierungstransaktionen, um detaillierte auf Capital bezogene Transaktionsinformationen aufzunehmen.
Überwachung von Capital-Transaktionen
Die folgenden Arten von Saldo-Transaktionen stehen im Zusammenhang mit der Finanzierung Ihrer verbundenen Konten, einschließlich Händlervorschüssen und Darlehen.
- Auszahlung:
payout - Anzahlung:
payment - Storno:
reversal
Auszahlung
Jede Auszahlung der Finanzierung hat ein Objekt Finanzierungstransaktion mit dem Typ payout. Nach der Erstellung einer Auszahlungsfinanzierungstransaktion sendet Stripe einen Webhook capital.financing_transaction.created. Es kann einige Werktage dauern, bis die ACH-Gelder auf dem Bankkonto eines verbundenen Kontos eingehen.
Achten Sie auf das Webhook-Ereignis und aktualisieren Sie Ihre nutzerdefinierten Auszahlungsberichte, um den Finanzierungsbetrag anzuzeigen, der an das externe Bankkonto des verbundenen Kontos gesendet wurde.
Anzahlung
Um einbehaltene Transaktionen in Ihrer Nutzeroberfläche anzuzeigen:
- Financing Transactions abrufen und nach Transaktionstyp filtern.
- Geben Sie die Konto-ID des verbundenen Kontos im Header
Stripe-Accountan.
Wenn die Liste der Finanzierungstransaktionen erfolgreich abgerufen wurde, erhalten Sie eine Antwort ähnlich der folgenden:
{ "object": "list", "url": "/v1/capital/financing_transactions?financing_offer=financingoffer_1NAdVWJQ3aJgxqz5nh90Zqrs&charge=ch_1HoZftJQ3aJgxqz50EbvL8zU", "has_more": false, "data": [ { "id": "cptxn_1NAdVWJQ3aJgxqz5FSScvJaF", "object": "capital.financing_transaction", "account": "acct_1HLGiXJQ3aJgxqz5", "created_at": 1684780258, "details": { "advance_amount": 10000, "currency": "usd", "fee_amount": 1000, "linked_payment": "ch_1HoZftJQ3aJgxqz50EbvL8zU", "reason": "automatic_withholding", "total_amount": 11000, "transaction": { "charge": "ch_1HoZftJQ3aJgxqz50EbvL8zU" } }, "financing_offer": "financingoffer_1NAdVWJQ3aJgxqz5nh90Zqrs", "livemode": true, "type": "payment", "user_facing_description": "Paydown of your loan" }, {...}, {...} ] }
Die Antwort enthält Informationen darüber, wie sich diese bestimmte Rückzahlung auf den ausstehenden Finanzierungsbetrag ausgewirkt hat. Wenn die Rückzahlung aufgrund von "details. erfolgt ist, enthält das Feld details. auch einen Verweis auf die ursprüngliche Stripe-Zahlung.
Storno
Jede Stornierung hat ein Objekt Finanzierungstransaktion mit dem Typ reversal. Eine Stornierung kann aufgrund einer fehlgeschlagenen ACH-Transaktion, einer Finanzierungskündigung oder einer manuellen Stornierungsanfrage erfolgen. Die Bereitstellung von Stornotransaktionen dient zwei Zwecken:
- Sie können auf eine abgebrochene Finanzierung hinweisen. Wenn Sie die ursprüngliche Auszahlung der Finanzierung in Ihre Berichte aufgenommen haben, geben Sie auch alle Stornos an. Auf diese Weise können die verbundenen Konten sehen, dass sich beide Transaktionen gegenseitig aufheben.
- Sie können zuvor einbehaltene Gelder auf ein verbundenes Konto zurückführen. Wenn Sie Stornierungen in Ihren Berichten auslassen, kann dies zu Abgleichproblemen bei verbundenen Konten führen, da die Berichte möglicherweise eine ungenaue Finanzierung widerspiegeln.
Destination Charges
Wenn Ihre Plattform Zahlungen unter Verwendung von Destination Charges verarbeitet und Sie die Auszahlung der Finanzierungstransaktion mit der ursprünglichen Gebühr abgleichen möchten, die auf Ihrer Plattform angefallen ist, extrahieren Sie die ID der Gebühr in dem Feld details. der Finanzierungstransaktion. Diese wird auf die Zahlungs-ID gesetzt, die als Ergebnis der automatischen Überweisung auf das verbundene Konto erfolgte:
{ "id": "cptxn_1NBJQR2eZvKYlo2CBUy2GQ1S", "object": "capital.financing_transaction", "details": { "reason": "automatic_withholding", "transaction": { "charge": "py_1NBJI62c99H72o8MUEN0fIZx" }, ... }, "type": "payment", ... }
Sie können dann die Retrieve Charge API verwenden, um das Zahlungsobjekt abzurufen:
{ "id": "py_1NBJI62c99H72o8MUEN0fIZx", "object": "charge", "source_transfer": "tr_3NBJGW2eZvKYlo2C1jQOxNwF", ... }
Da es sich um eine Destination Charges handelt, wird die ID Transfer in die Variable source_ eingetragen. Verwenden Sie die Retrieve Transfer API, um das Transfer-Objekt zu erhalten
{ "id": "tr_3NBJGW2eZvKYlo2C1jQOxNwF", "object": "transfer", "source_transaction": "ch_3NBJGW2eZvKYlo2C17oDFajw", ... }
Das Feld source_ enthält die ID der Zahlung, die auf Ihrer Plattform erfolgt ist und eine Übertragung auf das verbundene Konto ausgelöst hat.
Bereitstellen von Berichten
Sie können Anzahlungen in jeder Liste von Finanzierungstransaktionen oder entsprechenden Modellen anzeigen, die Sie in der Nutzeroberfläche Ihrer Plattform haben. Beispiel:
- Vorhandene Berichte: Für vorhandene Berichte, die die einzelnen Transaktionen eines verbundenen Kontos (einschließlich der Plattformgebühr oder Verrechnungskosten) anzeigen, sollten Sie in Betracht ziehen, einen einbehaltenen Betrag in den Bericht aufzunehmen.
- Neue Berichte: Für neue Berichte zeigen Sie alle einbehaltenen Beträge für einen bestimmten Zeitraum an. Dadurch können Ihre verbundenen Konten sehen, wie viel ihrer Umsatzabwicklung für ihre Finanzierung verwendet wird. Für Auszahlungsberichte können Sie einen Gesamtbetrag angeben, der einbehalten wird. Auf diese Weisen können verbundene Konten ihren gesamten eingehenden Umsatz abzüglich der Einbehaltung (und etwaiger von Ihnen berechneter Plattformgebühren) abgleichen, um den Auszahlungsbetrag zu ermitteln, den sie auf ihrem externen Bankkonto erwarten…
Bereitstellung von Ad-hoc-Berichten
Wir bieten drei Optionen zur Bereitstellung von Ad-hoc-Berichten.
Konto-Link
Für On-Demand-Berichte können Sie einen Konto-Link erstellen. Dieser Link leitet ein verbundenes Konto auf eine von Stripe gehostete Capital-Seite um (dieselbe, die in den E-Mails gesendet wird), auf der Sie Ihre Capital-Transaktionen und den Zahlungsfortschritt einsehen können. Diese Seite enthält keine Standardinformationen zur Zahlungsabwicklung (wie Gebühren, Rückerstattungen oder angefochtene Zahlungen).
Um einen Kontolink zu erstellen, setzen Sie den Typ auf capital_:
curl https://api.stripe.com/v1/account_links \ -u sk_test_26PHem9AhJZvU623DfE1x4sd: \ -d account=acct_123 \ -d refresh_url="https://example.com/reauth" \ -d return_url="https://example.com/thanks" \ -d type=capital_financing_reporting
Stripe Sigma
Wenn Sie Stripe Sigma verwenden, können Sie auch Abfragen erstellen und das Schema verwenden, um Analyseberichte für Ihre verbundenen Konten zu erstellen. Um auf Sigma-Berichte im Stripe-Dashboard zuzugreifen, siehe:
- connected_account_financing_balances: Verwenden Sie diese Tabelle, um ausstehende Finanzierungssalden zu melden.
- connected_account_financing_transactions : Verwenden Sie diese Tabelle, um Auszahlungen, Rückzahlungen und Stornos zu melden.
Sie können Sigma auch verwenden, um Standardinformationen zur Zahlungsabwicklung (wie Gebühren, Rückerstattungen oder angefochtene Zahlungen) zu finden.
CSV-Dateien
Nachdem Sie automatische Finanzierungsangebote an berechtigte verbundene Konten gesendet haben, können Sie diese Angebote im Dashboard verfolgen. Wenn Sie ein akzeptiertes Finanzierungsangebot auswählen, können Sie dessen Transaktionshistorie einsehen, samt der anfänglichen Auszahlung und der nachfolgenden Capital-Transaktion.
Um diese Daten als CSV-Datei zu exportieren und mit dem entsprechenden verbundenen Konto zu teilen, klicken Sie oben auf der Registerkarte Angebote auf Exportieren. Diese Daten enthalten nur Capital-Transaktionen (wie Auszahlungen, Anzahlungen und Stornos) und beinhalten keine Standardinformationen zur Zahlungsabwicklung (wie Gebühren, Rückerstattungen oder angefochtene Zahlungen).
Testen
Sie können eine Sandbox verwenden, um Finanzierungsangebote in verschiedenen Kontostatus für verbundene Konten zu erstellen.
Um Testszenarien zu erstellen:
Erstellen Sie eine Sandbox in Ihrer Testumgebung.
Generieren Sie Testangebote über das Capital-Dashboard.
Aktualisieren Sie Angebote als zugestellt und simulieren Sie die Annahme.
Testen Sie automatische Auszahlungen, indem Sie Gelder genehmigen und auszahlen lassen.
Testen Sie eine Auszahlung oder eine Anzahlung. Sie können eine Stornierung nicht testen, da diese nur von Stripe unter bestimmten Umständen initiiert wird.
- Payouts:
- Vergewissern Sie sich, dass automatische Auszahlungen nach Annahme des Angebots erfolgen.
- Behalten Sie die
capital.Webhooks im Auge.financing_ transaction. created - Bestätigen Sie, dass Auszahlungen in Ihrem Bericht erscheinen.
- Anzahlungen:
- Testen Sie den automatischen Einbehalt, indem Sie Testzahlungen verarbeiten.
- Simulieren Sie manuelle Anzahlungen über das Capital-Dashboard.
- Vergewissern Sie sich, dass die Transaktionen der Anzahlung in Ihrer Integration für die Berichterstattung erscheinen.
- Payouts:
Bestätigen Sie, dass die Transaktionsdetails in Ihrer Berichtsschnittstelle korrekt angezeigt werden.
Überprüfen Sie die Verarbeitung von Webhooks für Transaktionsbenachrichtigungen.
Testen Sie Links zu Konten oder eingebettete Komponenten (falls implementiert).
Validieren Sie die Prozesse zum Abgleich von Transaktionen.
Senden Sie nach dem Test manuell ein Live-Angebot, um Ihre Berichte zu überprüfen, bevor Sie automatische Angebote für alle in Frage kommenden verbundenen Konten aktivieren. Weitere Informationen finden Sie unter Testen.