ファイルアップロードガイド
API を使用して Stripe にファイルをアップロードすると、ファイルトークンとファイルに関するその他の情報が返されます。このトークンは、他の API コールに使用できます。このガイドでは、このプロセスの詳細を説明します。
ファイルのアップロード
ファイルをアップロードするには、multipart/form-data
リクエストを https://files.stripe.com/v1/files に送信します。サブドメインの files.stripe.com は、Stripe の多くの API エンドポイントとは異なることに注意してください。リクエストで、purpose
と file
を指定する必要があります。以下の例は、お客様のローカルファイルシステムにあるファイル /path/to/a/file.jpg を、purpose を dispute_evidence
としてアップロードします。
以下の例は、Stripe の Android SDK を使用し、目的を dispute_evidence
としてファイルをアップロードします。
いくつかの有効な目的値があり、それぞれにファイル形式とサイズの要件があります。
Purpose | Description | Supported mimetypes | Max size | Expiry | Downloadable |
---|---|---|---|---|---|
account_requirement | Additional documentation requirements that can be requested for an account. | PDF JPEG PNG | 16MB | NEVER | false |
business_icon | A business icon. | JPEG PNG GIF | 512KB | NEVER | true |
business_logo | A business logo. | JPEG PNG GIF | 512KB | NEVER | true |
customer_signature | Customer signature image. | JPEG PNG SVG | 4MB | 7 days | true |
dispute_evidence | Evidence to submit with a dispute response. | PDF JPEG PNG | 5MB | 9 months | true |
identity_document | A document to verify the identity of an account owner during account provisioning. | PDF JPEG PNG | 16MB | NEVER | false |
pci_document | A self-assessment PCI questionnaire. | PDF | 16MB | NEVER | true |
tax_document_user_upload | A user-uploaded tax document. | PDF CSV JPEG PNG XLSX DOCX | 16MB | NEVER | true |
additional_verification | Additional verification for custom accounts. | PDF JPEG PNG | 16MB | NEVER | false |
terminal_reader_splashscreen | Splashscreen to be displayed on Terminal readers. | PNG JPEG GIF | 4.194304MB | 1 year | true |
注意
identity_document
画像は、8,000 ピクセル x 8,000 ピクセル未満である必要があります。
アップロードするファイルの MIME タイプは、そのファイル形式に対応している必要があります。
File format | MIME type |
---|---|
APK | application/vnd.android.package-archive |
CSV | text/csv |
DOCX | application/vnd.openxmlformats-officedocument.wordprocessingml.document |
GIF | image/gif |
HTML | text/html |
JPEG | image/jpeg |
JSON | application/json |
JSONL | application/jsonl |
MARKDOWN | text/markdown |
application/pdf | |
PNG | image/png |
SVG | image/svg+xml |
TIFF | image/tiff |
TSV | text/tab-separated-values |
TXT | text/plain |
XLS | application/vnd.ms-excel |
XLSM | application/vnd.ms-excel.sheet.macroEnabled.12 |
XLSX | application/vnd.openxmlformats-officedocument.spreadsheetml.sheet |
XML | application/xml |
ZIP | application/zip |
注意
セキュリティ上の理由により、VBA マクロが含まれる Microsoft Office ドキュメントは拒否されます。
リクエストが成功すると、File (ファイル) オブジェクトが返されます。
File API リソースを取得する
File の API リソースを取得するには、ファイルアップロード ID を指定して、files.stripe.com サブドメインの /v1/files エンドポイントに対して GET リクエストを実行します。
ファイルコンテンツをダウンロードする
ファイルの目的で、ファイルコンテンツのダウンロードが許可されている場合は、File に、コンテンツへのアクセス方法を示す null 以外の url
フィールドが含まれます。この url は、お客様の Stripe API キーでの認証を必要とします。
curl https://files.stripe.com/v1/files/
-u{{FILE_ID}}sk_test_4eC39HqLyjWDarjtT1zdp7dc
目的でダウンロードが許可されている場合に、そのファイルへの未認証のアクセスを許可するには、file_link を作成して匿名のダウンロードリンクを生成できます。
file_link リソースには、ファイルのコンテンツへの未認証アクセスを許可する url
フィールドがあります。
ファイルを使用する
ファイルをアップロードしたら、そのファイルアップロード ID を他の API リクエストで使用できます。たとえば、アップロードしたファイルを特定の不審請求の申請に反証資料として関連付けることができます。
アップロードされたファイルは、1 つの API リクエストのみで使用できることに注意してください。
アップロードエラーを処理する
File API を使用して PDF ドキュメントをアップロードすると、一連のチェックが行われ、そのドキュメントが正しくフォーマットされ、PDF 仕様を満たしていることが検証されます。いずれかのチェックに失敗した場合には、アップロードエラーが返されます。
以下を試し、検出されたエラーを修正してください。
- ドキュメントに追加された注釈や追加メディアを削除します。
- 注釈やメディアを削除できない場合、または複数の PDF を 1 つにまとめた場合には、お使いのコンピュータの「PDF に印刷」機能を使用して、新しいドキュメントを作成してください。