Package com.stripe.model

Class File

java.lang.Object

com.stripe.model.StripeObject

com.stripe.net.ApiResource

com.stripe.model.File

All Implemented Interfaces:

HasId, StripeObjectInterface

public class File
extends ApiResource
implements HasId

This is an object representing a file hosted on Stripe's servers. The file may have been uploaded by yourself using the create file request (for example, when uploading dispute evidence) or it may have been created by Stripe (for example, the results of a Sigma scheduled query).

Related guide: File upload guide

Nested Class Summary

Nested classes/interfaces inherited from class com.stripe.net.ApiResource

ApiResource.RequestMethod

Field Summary

Fields inherited from class com.stripe.net.ApiResource

CHARSET, GSON

Fields inherited from class com.stripe.model.StripeObject

PRETTY_PRINT_GSON

Constructor Summary

Constructors

Constructor	Description
File()

Method Summary

Modifier and Type	Method	Description
protected boolean	canEqual(Object other)
static File	create(FileCreateParams params)	To upload a file to Stripe, you’ll need to send a request of type multipart/form-data.
static File	create(FileCreateParams params, RequestOptions options)	To upload a file to Stripe, you’ll need to send a request of type multipart/form-data.
static File	create(Map<String,Object> params)	To upload a file to Stripe, you’ll need to send a request of type multipart/form-data.
static File	create(Map<String,Object> params, RequestOptions options)	To upload a file to Stripe, you’ll need to send a request of type multipart/form-data.
boolean	equals(Object o)
Long	getCreated()	Time at which the object was created.
Long	getExpiresAt()	The time at which the file expires and is no longer available in epoch seconds.
String	getFilename()	A filename for the file, suitable for saving to a filesystem.
String	getId()	Unique identifier for the object.
FileLinkCollection	getLinks()	A list of file links that point at this file.
String	getObject()	String representing the object's type.
String	getPurpose()	The purpose of the uploaded file.
Long	getSize()	The size in bytes of the file object.
String	getTitle()	A user friendly title for the document.
String	getType()	The type of the file returned (e.g., csv, pdf, jpg, or png).
String	getUrl()	The URL from which the file can be downloaded using your live secret API key.
int	hashCode()
static FileCollection	list(FileListParams params)	Returns a list of the files that your account has access to.
static FileCollection	list(FileListParams params, RequestOptions options)	Returns a list of the files that your account has access to.
static FileCollection	list(Map<String,Object> params)	Returns a list of the files that your account has access to.
static FileCollection	list(Map<String,Object> params, RequestOptions options)	Returns a list of the files that your account has access to.
static File	retrieve(String file)	Retrieves the details of an existing file object.
static File	retrieve(String file, RequestOptions options)	Retrieves the details of an existing file object.
static File	retrieve(String file, FileRetrieveParams params, RequestOptions options)	Retrieves the details of an existing file object.
static File	retrieve(String file, Map<String,Object> params, RequestOptions options)	Retrieves the details of an existing file object.
void	setCreated(Long created)	Time at which the object was created.
void	setExpiresAt(Long expiresAt)	The time at which the file expires and is no longer available in epoch seconds.
void	setFilename(String filename)	A filename for the file, suitable for saving to a filesystem.
void	setId(String id)	Unique identifier for the object.
void	setLinks(FileLinkCollection links)	A list of file links that point at this file.
void	setObject(String object)	String representing the object's type.
void	setPurpose(String purpose)	The purpose of the uploaded file.
void	setSize(Long size)	The size in bytes of the file object.
void	setTitle(String title)	A user friendly title for the document.
void	setType(String type)	The type of the file returned (e.g., csv, pdf, jpg, or png).
void	setUrl(String url)	The URL from which the file can be downloaded using your live secret API key.

Methods inherited from class com.stripe.net.ApiResource

checkNullTypedParams, classUrl, classUrl, fullUrl, instanceUrl, instanceUrl, rawRequest, request, request, requestCollection, requestCollection, requestSearchResult, requestSearchResult, requestStream, requestStream, setExpandableFieldId, setStripeResponseGetter, singleClassUrl, singleClassUrl, subresourceUrl, urlEncode, urlEncodeId

Methods inherited from class com.stripe.model.StripeObject

deserializeStripeObject, equals, getLastResponse, getRawJsonObject, setLastResponse, toJson, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

File

public File()

Method Details

create

public static File create(Map<String,Object> params)
                   throws StripeException

To upload a file to Stripe, you’ll need to send a request of type multipart/form-data. The request should contain the file you would like to upload, as well as the parameters for creating a file.

All of Stripe’s officially supported Client libraries should have support for sending multipart/form-data.

Throws:

StripeException

create

public static File create(Map<String,Object> params,
 RequestOptions options)
                   throws StripeException

To upload a file to Stripe, you’ll need to send a request of type multipart/form-data. The request should contain the file you would like to upload, as well as the parameters for creating a file.

All of Stripe’s officially supported Client libraries should have support for sending multipart/form-data.

Throws:

StripeException

create

public static File create(FileCreateParams params)
                   throws StripeException

To upload a file to Stripe, you’ll need to send a request of type multipart/form-data. The request should contain the file you would like to upload, as well as the parameters for creating a file.

All of Stripe’s officially supported Client libraries should have support for sending multipart/form-data.

Throws:

StripeException

create

public static File create(FileCreateParams params,
 RequestOptions options)
                   throws StripeException

To upload a file to Stripe, you’ll need to send a request of type multipart/form-data. The request should contain the file you would like to upload, as well as the parameters for creating a file.

All of Stripe’s officially supported Client libraries should have support for sending multipart/form-data.

Throws:

StripeException

list

public static FileCollection list(Map<String,Object> params)
                           throws StripeException

Returns a list of the files that your account has access to. The files are returned sorted by creation date, with the most recently created files appearing first.

Throws:

StripeException

list

public static FileCollection list(Map<String,Object> params,
 RequestOptions options)
                           throws StripeException

Returns a list of the files that your account has access to. The files are returned sorted by creation date, with the most recently created files appearing first.

Throws:

StripeException

list

public static FileCollection list(FileListParams params)
                           throws StripeException

Returns a list of the files that your account has access to. The files are returned sorted by creation date, with the most recently created files appearing first.

Throws:

StripeException

list

public static FileCollection list(FileListParams params,
 RequestOptions options)
                           throws StripeException

Returns a list of the files that your account has access to. The files are returned sorted by creation date, with the most recently created files appearing first.

Throws:

StripeException

retrieve

public static File retrieve(String file)
                     throws StripeException

Retrieves the details of an existing file object. Supply the unique file ID from a file, and Stripe will return the corresponding file object. To access file contents, see the File Upload Guide.

Throws:

StripeException

retrieve

public static File retrieve(String file,
 RequestOptions options)
                     throws StripeException

Retrieves the details of an existing file object. Supply the unique file ID from a file, and Stripe will return the corresponding file object. To access file contents, see the File Upload Guide.

Throws:

StripeException

retrieve

public static File retrieve(String file,
 Map<String,Object> params,
 RequestOptions options)
                     throws StripeException

Retrieves the details of an existing file object. Supply the unique file ID from a file, and Stripe will return the corresponding file object. To access file contents, see the File Upload Guide.

Throws:

StripeException

retrieve

public static File retrieve(String file,
 FileRetrieveParams params,
 RequestOptions options)
                     throws StripeException

Retrieves the details of an existing file object. Supply the unique file ID from a file, and Stripe will return the corresponding file object. To access file contents, see the File Upload Guide.

Throws:

StripeException

getCreated

public Long getCreated()

Time at which the object was created. Measured in seconds since the Unix epoch.

getExpiresAt

public Long getExpiresAt()

The time at which the file expires and is no longer available in epoch seconds.

getFilename

public String getFilename()

A filename for the file, suitable for saving to a filesystem.

getLinks

public FileLinkCollection getLinks()

A list of file links that point at this file.

getObject

public String getObject()

String representing the object's type. Objects of the same type share the same value.

Equal to file.

getPurpose

public String getPurpose()

The purpose of the uploaded file.

One of account_requirement, additional_verification, business_icon, business_logo, customer_signature, dispute_evidence, document_provider_identity_document, finance_report_run, identity_document, identity_document_downloadable, pci_document, selfie, sigma_scheduled_query, tax_document_user_upload, or terminal_reader_splashscreen.

getSize

public Long getSize()

The size in bytes of the file object.

getTitle

public String getTitle()

A user friendly title for the document.

getType

public String getType()

The type of the file returned (e.g., csv, pdf, jpg, or png).

getUrl

public String getUrl()

The URL from which the file can be downloaded using your live secret API key.

setCreated

public void setCreated(Long created)

Time at which the object was created. Measured in seconds since the Unix epoch.

setExpiresAt

public void setExpiresAt(Long expiresAt)

The time at which the file expires and is no longer available in epoch seconds.

setFilename

public void setFilename(String filename)

A filename for the file, suitable for saving to a filesystem.

setId

public void setId(String id)

Unique identifier for the object.

setLinks

public void setLinks(FileLinkCollection links)

A list of file links that point at this file.

setObject

public void setObject(String object)

String representing the object's type. Objects of the same type share the same value.

Equal to file.

setPurpose

public void setPurpose(String purpose)

The purpose of the uploaded file.

One of account_requirement, additional_verification, business_icon, business_logo, customer_signature, dispute_evidence, document_provider_identity_document, finance_report_run, identity_document, identity_document_downloadable, pci_document, selfie, sigma_scheduled_query, tax_document_user_upload, or terminal_reader_splashscreen.

setSize

public void setSize(Long size)

The size in bytes of the file object.

setTitle

public void setTitle(String title)

A user friendly title for the document.

setType

public void setType(String type)

The type of the file returned (e.g., csv, pdf, jpg, or png).

setUrl

public void setUrl(String url)

The URL from which the file can be downloaded using your live secret API key.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

canEqual

protected boolean canEqual(Object other)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getId

public String getId()

Unique identifier for the object.

Specified by:

getId in interface HasId