Anleitung zum Hochladen von Dateien

Wenn Sie eine Datei mit der API bei Stripe hochladen, werden ein Datei-Token und andere Informationen über die Datei zurückgegeben. Das Token kann anschließend in anderen API-Aufrufen verwendet werden. Diese Anleitung führt Sie Schritt für Schritt durch diesen Vorgang.

Datei hochladen

Um eine Datei hochzuladen, senden Sie eine multipart/form-data-Anfrage an https://files.stripe.com/v1/files. Beachten Sie, dass die Subdomain files.stripe.com sich von den meisten API-Endpoints von Stripe unterscheidet. In der Anfrage sollten ein purpose und eine file angegeben werden. Im folgenden Beispiel wird eine Datei hochgeladen, die sich unter /path/to/a/file.jpg auf Ihrem lokalen Dateisystem befindet und den Zweck dispute_evidence hat:

curl https://files.stripe.com/v1/files \
  -u 
sk_test_4eC39HqLyjWDarjtT1zdp7dc
: \
  -F "file"="@/path/to/a/file.jpg" \
  -F "purpose"="dispute_evidence"

Im folgenden Beispiel wird eine Datei über unser Android SDK mit dem Zweck dispute_evidence hochgeladen:

class CheckoutActivity : AppCompatActivity() {
    private val stripe: Stripe by lazy {
        Stripe(this, 
"pk_test_TYooMQauvdEDq54NiTphI7jx")
    }

    private fun uploadFile(file: File) {
        stripe.createFile(
            StripeFileParams(
                file,
                StripeFilePurpose.DisputeEvidence
            ),
            callback = object : ApiResultCallback<StripeFile> {
                override fun onSuccess(result: StripeFile) {
                    // File upload succeeded
                }

                override fun onError(e: Exception) {
                    // File upload failed
                }

            }
        )
    }
}

Es gibt mehrere gültige Werte für Zwecke, die unterschiedliche Anforderungen an das Dateiformat und die Größe haben.

Der MIME-Typ der Datei, die Sie hochladen möchten, muss dem Dateiformat entsprechen.

Eine erfolgreiche Anfrage gibt ein File-Objekt zurück.

File API-Ressource abrufen

Um die API-Ressource für eine Datei abzurufen, stellen Sie eine GET-Anfrage an den Endpoint /v1/files der Subdomain files.stripe.com unter Angabe der ID für den Datei-Upload:

curl https://files.stripe.com/v1/files/
{{FILE_ID}} \
  -u 
sk_test_4eC39HqLyjWDarjtT1zdp7dc

Wenn Sie eingeschränkte API-Schlüssel verwenden, müssen Sie zuvor Zugriff auf die Ressource Files erhalten.

Dateiinhalte herunterladen

Wenn der Dateizweck das Herunterladen des Dateiinhalts zulässt, dann enthält die Datei das Feld url. Dieses ist nicht null und gibt die Zugriffsmöglichkeit auf den Inhalt an. Die URL erfordert eine Authentifizierung mit Ihren Stripe-API-Schlüsseln.

curl https://files.stripe.com/v1/files/
{{FILE_ID}}
/contents
  -u 
sk_test_4eC39HqLyjWDarjtT1zdp7dc

Wenn Sie nicht authentifizierten Zugriff auf eine Datei benötigen, deren Zweck das Herunterladen zulässt, dann können Sie durch Erstellen eines file_link anonyme Download-Links erzeugen.

curl https://api.stripe.com/v1/file_links \
  -u 
sk_test_4eC39HqLyjWDarjtT1zdp7dc
  -d file=
{{FILE_ID}}

Die file_link-Ressource verfügt über das Feld url, das einen nicht authentifizierten Zugriff auf den Inhalt der Datei ermöglicht.

Datei verwenden

Nachdem eine Datei hochgeladen wurde, kann die ID des Datei-Uploads in anderen API-Anfragen verwendet werden. So lässt sich beispielsweise eine hochgeladene Datei einer bestimmten Zahlungsanfechtung als Nachweis zuordnen.

curl https://api.stripe.com/v1/disputes/
{{DISPUTE_ID}}
  -u 
sk_test_4eC39HqLyjWDarjtT1zdp7dc
  -d "evidence[receipt]"=
{{FILE_ID}}

Beachten Sie, dass Sie eine hochgeladene Datei nur in einer einzelnen API-Anfrage verwenden können.

Fehler beim Hochladen beheben

Wenn Sie die File API zum Hochladen eines PDF-Dokuments verwenden, wird das Dokument einer Reihe von Prüfungen unterzogen, um die korrekte Formatierung und die Einhaltung der PDF-Spezifikationen sicherzustellen. Falls eine der Prüfungen für das Hochladen fehlschlägt, wird ein Fehler zurückgegeben.

Führen Sie folgende Schritte aus, um erkannte Fehler zu beheben:

• Entfernen Sie Kommentare oder sonstige dem Dokument hinzugefügte Medien.
• Wenn Sie Ihre Kommentare oder Medien nicht entfernen können oder wenn Sie mehrere PDF-Dateien zu einer zusammengefasst haben, können Sie mit der Funktion „Print to PDF” Ihres Computers ein neues Dokument erstellen.
  • Als PDF druckeen mit macOS
  • Als PDF drucken mit Adobe Acrobat