Package com.stripe.service

Class RefundService

java.lang.Object

com.stripe.net.ApiService

com.stripe.service.RefundService

public final class RefundService
extends ApiService

Constructor Summary

Constructors

Constructor	Description
RefundService(StripeResponseGetter responseGetter)

Method Summary

Modifier and Type	Method	Description
Refund	cancel(String refund)	Cancels a refund with a status of requires_action.
Refund	cancel(String refund, RequestOptions options)	Cancels a refund with a status of requires_action.
Refund	cancel(String refund, RefundCancelParams params)	Cancels a refund with a status of requires_action.
Refund	cancel(String refund, RefundCancelParams params, RequestOptions options)	Cancels a refund with a status of requires_action.
Refund	create()	When you create a new refund, you must specify a Charge or a PaymentIntent object on which to create it.
Refund	create(RequestOptions options)	When you create a new refund, you must specify a Charge or a PaymentIntent object on which to create it.
Refund	create(RefundCreateParams params)	When you create a new refund, you must specify a Charge or a PaymentIntent object on which to create it.
Refund	create(RefundCreateParams params, RequestOptions options)	When you create a new refund, you must specify a Charge or a PaymentIntent object on which to create it.
StripeCollection<Refund>	list()	Returns a list of all refunds you created.
StripeCollection<Refund>	list(RequestOptions options)	Returns a list of all refunds you created.
StripeCollection<Refund>	list(RefundListParams params)	Returns a list of all refunds you created.
StripeCollection<Refund>	list(RefundListParams params, RequestOptions options)	Returns a list of all refunds you created.
Refund	retrieve(String refund)	Retrieves the details of an existing refund.
Refund	retrieve(String refund, RequestOptions options)	Retrieves the details of an existing refund.
Refund	retrieve(String refund, RefundRetrieveParams params)	Retrieves the details of an existing refund.
Refund	retrieve(String refund, RefundRetrieveParams params, RequestOptions options)	Retrieves the details of an existing refund.
Refund	update(String refund)	Updates the refund that you specify by setting the values of the passed parameters.
Refund	update(String refund, RequestOptions options)	Updates the refund that you specify by setting the values of the passed parameters.
Refund	update(String refund, RefundUpdateParams params)	Updates the refund that you specify by setting the values of the passed parameters.
Refund	update(String refund, RefundUpdateParams params, RequestOptions options)	Updates the refund that you specify by setting the values of the passed parameters.

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

RefundService

public RefundService(StripeResponseGetter responseGetter)

Method Details

list

public StripeCollection<Refund> list(RefundListParams params)
                              throws StripeException

Returns a list of all refunds you created. We return the refunds in sorted order, with the most recent refunds appearing first. The 10 most recent refunds are always available by default on the Charge object.

Throws:

StripeException

list

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

Returns a list of all refunds you created. We return the refunds in sorted order, with the most recent refunds appearing first. The 10 most recent refunds are always available by default on the Charge object.

Throws:

StripeException

list

public StripeCollection<Refund> list()
                              throws StripeException

Returns a list of all refunds you created. We return the refunds in sorted order, with the most recent refunds appearing first. The 10 most recent refunds are always available by default on the Charge object.

Throws:

StripeException

list

public StripeCollection<Refund> list(RefundListParams params,
 RequestOptions options)
                              throws StripeException

Returns a list of all refunds you created. We return the refunds in sorted order, with the most recent refunds appearing first. The 10 most recent refunds are always available by default on the Charge object.

Throws:

StripeException

create

public Refund create(RefundCreateParams params)
              throws StripeException

When you create a new refund, you must specify a Charge or a PaymentIntent object on which to create it.

Creating a new refund will refund a charge that has previously been created but not yet refunded. Funds will be refunded to the credit or debit card that was originally charged.

You can optionally refund only part of a charge. You can do so multiple times, until the entire charge has been refunded.

Once entirely refunded, a charge can’t be refunded again. This method will raise an error when called on an already-refunded charge, or when trying to refund more money than is left on a charge.

Throws:

StripeException

create

public Refund create(RequestOptions options)
              throws StripeException

When you create a new refund, you must specify a Charge or a PaymentIntent object on which to create it.

Creating a new refund will refund a charge that has previously been created but not yet refunded. Funds will be refunded to the credit or debit card that was originally charged.

You can optionally refund only part of a charge. You can do so multiple times, until the entire charge has been refunded.

Once entirely refunded, a charge can’t be refunded again. This method will raise an error when called on an already-refunded charge, or when trying to refund more money than is left on a charge.

Throws:

StripeException

create

public Refund create()
              throws StripeException

When you create a new refund, you must specify a Charge or a PaymentIntent object on which to create it.

Creating a new refund will refund a charge that has previously been created but not yet refunded. Funds will be refunded to the credit or debit card that was originally charged.

You can optionally refund only part of a charge. You can do so multiple times, until the entire charge has been refunded.

Once entirely refunded, a charge can’t be refunded again. This method will raise an error when called on an already-refunded charge, or when trying to refund more money than is left on a charge.

Throws:

StripeException

create

public Refund create(RefundCreateParams params,
 RequestOptions options)
              throws StripeException

When you create a new refund, you must specify a Charge or a PaymentIntent object on which to create it.

Creating a new refund will refund a charge that has previously been created but not yet refunded. Funds will be refunded to the credit or debit card that was originally charged.

You can optionally refund only part of a charge. You can do so multiple times, until the entire charge has been refunded.

Once entirely refunded, a charge can’t be refunded again. This method will raise an error when called on an already-refunded charge, or when trying to refund more money than is left on a charge.

Throws:

StripeException

retrieve

public Refund retrieve(String refund,
 RefundRetrieveParams params)
                throws StripeException

Retrieves the details of an existing refund.

Throws:

StripeException

retrieve

public Refund retrieve(String refund,
 RequestOptions options)
                throws StripeException

Retrieves the details of an existing refund.

Throws:

StripeException

retrieve

public Refund retrieve(String refund)
                throws StripeException

Retrieves the details of an existing refund.

Throws:

StripeException

retrieve

public Refund retrieve(String refund,
 RefundRetrieveParams params,
 RequestOptions options)
                throws StripeException

Retrieves the details of an existing refund.

Throws:

StripeException

update

public Refund update(String refund,
 RefundUpdateParams params)
              throws StripeException

Updates the refund that you specify by setting the values of the passed parameters. Any parameters that you don’t provide remain unchanged.

This request only accepts metadata as an argument.

Throws:

StripeException

update

public Refund update(String refund,
 RequestOptions options)
              throws StripeException

Updates the refund that you specify by setting the values of the passed parameters. Any parameters that you don’t provide remain unchanged.

This request only accepts metadata as an argument.

Throws:

StripeException

update

public Refund update(String refund)
              throws StripeException

Updates the refund that you specify by setting the values of the passed parameters. Any parameters that you don’t provide remain unchanged.

This request only accepts metadata as an argument.

Throws:

StripeException

update

public Refund update(String refund,
 RefundUpdateParams params,
 RequestOptions options)
              throws StripeException

Updates the refund that you specify by setting the values of the passed parameters. Any parameters that you don’t provide remain unchanged.

This request only accepts metadata as an argument.

Throws:

StripeException

cancel

public Refund cancel(String refund,
 RefundCancelParams params)
              throws StripeException

Cancels a refund with a status of requires_action.

You can’t cancel refunds in other states. Only refunds for payment methods that require customer action can enter the requires_action state.

Throws:

StripeException

cancel

public Refund cancel(String refund,
 RequestOptions options)
              throws StripeException

Cancels a refund with a status of requires_action.

You can’t cancel refunds in other states. Only refunds for payment methods that require customer action can enter the requires_action state.

Throws:

StripeException

cancel

public Refund cancel(String refund)
              throws StripeException

Cancels a refund with a status of requires_action.

You can’t cancel refunds in other states. Only refunds for payment methods that require customer action can enter the requires_action state.

Throws:

StripeException

cancel

public Refund cancel(String refund,
 RefundCancelParams params,
 RequestOptions options)
              throws StripeException

Cancels a refund with a status of requires_action.

You can’t cancel refunds in other states. Only refunds for payment methods that require customer action can enter the requires_action state.

Throws:

StripeException