Guide de chargement de fichiers

Lorsque vous chargez un fichier dans Stripe à l’aide d’une API, un token de fichier et d’autres informations sur le fichier sont renvoyés. Le token peut alors être utilisé dans d’autres appels à l’API. Ce guide vous accompagne tout au long de ce processus.

Chargement d’un fichier

Pour charger un fichier, envoyez une requête multipart/form-data à https://files.stripe.com/v1/files. Notez que le sous-domaine files.stripe.com est différent de la plupart des endpoints d’API de Stripe. La requête doit spécifier un purpose et un file. L’exemple suivant charge un fichier situé sous /path/to/a/file.jpg dans votre système de fichiers local avec l’objectif dispute_evidence :

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

L’exemple suivant charge un fichier à l’aide de notre SDK Android avec l’objectif dispute_evidence :

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
                }

            }
        )
    }
}

Il existe des valeurs d’objectif valides multiples, chacune aux exigences de taille et de format de fichier.

Le type MIME du fichier à charger doit correspondre à son format de fichier.

Une requête réussie renvoie un objet de fichier.

Récupération d’une ressource d’API de fichier

Pour récupérer la ressource d’API pour un fichier, envoyez une requête GET au endpoint /v1/files du sous-domaine files.stripe.com fournissant l’ID de chargement du fichier :

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

Lorsque vous utilisez des clés API limitées, vous devez bénéficier d’un accès préalable à la ressource Files.

Téléchargement du contenu du fichier

Si l’objectif du fichier permet de télécharger le contenu du fichier, alors le fichier inclut un champ url non nul indiquant comment accéder au contenu. Cette URL nécessite une authentification avec vos clés API Stripe.

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

Si vous voulez un accès non authentifié au fichier dont l’objectif permet le téléchargement, alors vous pouvez générer des liens de téléchargement anonyme en créant un file_link.

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

La ressource file_link a un champ url qui permet un accès non authentifié au contenu du fichier.

Utilisation d’un fichier

Après avoir chargé un fichier, l’ID de chargement de fichier peut être utilisé dans d’autres requêtes d’API. Par exemple, pour joindre un fichier chargé à un litige comme preuve :

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

Notez que vous ne pouvez utiliser un fichier chargé que dans une seule requête d’API.

Gestion des erreurs de chargement

Lorsque vous utilisez une API de fichier pour charger un document PDF, nous effectuons une série de vérifications pour confirmer qu’elle est correctement formatée et répond aux spécifications de PDF. Nous renvoyons une erreur pour les chargements qui ne satisfont pas nos vérifications.

Essayez ce qui suit pour corriger les erreurs que nous détectons :

• Supprimez les annotations ou les médias supplémentaires ajoutés au document.
• Si vous ne pouvez pas supprimer vos annotations ou médias, ou si vous avez combiné plusieurs PDF en un, essayez d’utiliser la fonction Imprimer au format PDF de votre ordinateur pour créer un nouveau document.
  • Imprimer au format PDF avec macOS
  • Imprimer au format PDF avec Adobe Acrobat