Package com.stripe.service

Class FileService

java.lang.Object

com.stripe.net.ApiService

com.stripe.service.FileService

public final class FileService
extends ApiService

Constructor Summary

Constructors

Constructor	Description
FileService(StripeResponseGetter responseGetter)

Method Summary

Modifier and Type	Method	Description
File	create(FileCreateParams params)	To upload a file to Stripe, you need to send a request of type multipart/form-data.
File	create(FileCreateParams params, RequestOptions options)	To upload a file to Stripe, you need to send a request of type multipart/form-data.
StripeCollection<File>	list()	Returns a list of the files that your account has access to.
StripeCollection<File>	list(RequestOptions options)	Returns a list of the files that your account has access to.
StripeCollection<File>	list(FileListParams params)	Returns a list of the files that your account has access to.
StripeCollection<File>	list(FileListParams params, RequestOptions options)	Returns a list of the files that your account has access to.
File	retrieve(String file)	Retrieves the details of an existing file object.
File	retrieve(String file, RequestOptions options)	Retrieves the details of an existing file object.
File	retrieve(String file, FileRetrieveParams params)	Retrieves the details of an existing file object.
File	retrieve(String file, FileRetrieveParams params, RequestOptions options)	Retrieves the details of an existing file object.

Methods inherited from class com.stripe.net.ApiService

getResponseGetter, request, requestStream

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

FileService

public FileService(StripeResponseGetter responseGetter)

Method Details

list

public StripeCollection<File> list(FileListParams params)
                            throws StripeException

Returns a list of the files that your account has access to. Stripe sorts and returns the files by their creation dates, placing the most recently created files at the top.

Throws:

StripeException

list

public StripeCollection<File> list(RequestOptions options)
                            throws StripeException

Returns a list of the files that your account has access to. Stripe sorts and returns the files by their creation dates, placing the most recently created files at the top.

Throws:

StripeException

list

public StripeCollection<File> list()
                            throws StripeException

Returns a list of the files that your account has access to. Stripe sorts and returns the files by their creation dates, placing the most recently created files at the top.

Throws:

StripeException

list

public StripeCollection<File> list(FileListParams params,
 RequestOptions options)
                            throws StripeException

Returns a list of the files that your account has access to. Stripe sorts and returns the files by their creation dates, placing the most recently created files at the top.

Throws:

StripeException

create

public File create(FileCreateParams params)
            throws StripeException

To upload a file to Stripe, you need to send a request of type multipart/form-data. Include the file you want to upload in the request, and the parameters for creating a file.

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

Throws:

StripeException

create

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

To upload a file to Stripe, you need to send a request of type multipart/form-data. Include the file you want to upload in the request, and the parameters for creating a file.

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

Throws:

StripeException

retrieve

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

Retrieves the details of an existing file object. After you supply a unique file ID, Stripe returns the corresponding file object. Learn how to access file contents.

Throws:

StripeException

retrieve

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

Retrieves the details of an existing file object. After you supply a unique file ID, Stripe returns the corresponding file object. Learn how to access file contents.

Throws:

StripeException

retrieve

public File retrieve(String file)
              throws StripeException

Retrieves the details of an existing file object. After you supply a unique file ID, Stripe returns the corresponding file object. Learn how to access file contents.

Throws:

StripeException

retrieve

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

Retrieves the details of an existing file object. After you supply a unique file ID, Stripe returns the corresponding file object. Learn how to access file contents.

Throws:

StripeException