Package com.stripe.service.v2.moneymanagement

Class PayoutMethodService

java.lang.Object

com.stripe.net.ApiService

com.stripe.service.v2.moneymanagement.PayoutMethodService

public final class PayoutMethodService
extends ApiService

Constructor Summary

Constructors

Constructor	Description
PayoutMethodService(StripeResponseGetter responseGetter)

Method Summary

Modifier and Type	Method	Description
PayoutMethod	archive(String id)	Archive a PayoutMethod.
PayoutMethod	archive(String id, RequestOptions options)	Archive a PayoutMethod.
StripeCollection<PayoutMethod>	list()	List objects that adhere to the PayoutMethod interface.
StripeCollection<PayoutMethod>	list(RequestOptions options)	List objects that adhere to the PayoutMethod interface.
StripeCollection<PayoutMethod>	list(PayoutMethodListParams params)	List objects that adhere to the PayoutMethod interface.
StripeCollection<PayoutMethod>	list(PayoutMethodListParams params, RequestOptions options)	List objects that adhere to the PayoutMethod interface.
PayoutMethod	retrieve(String id)	Retrieve a PayoutMethod object.
PayoutMethod	retrieve(String id, RequestOptions options)	Retrieve a PayoutMethod object.
PayoutMethod	unarchive(String id)	Unarchive a PayoutMethod.
PayoutMethod	unarchive(String id, RequestOptions options)	Unarchive a PayoutMethod.

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

PayoutMethodService

public PayoutMethodService(StripeResponseGetter responseGetter)

Method Details

list

public StripeCollection<PayoutMethod> list(PayoutMethodListParams params)
                                    throws StripeException

List objects that adhere to the PayoutMethod interface.

Throws:

StripeException

list

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

List objects that adhere to the PayoutMethod interface.

Throws:

StripeException

list

public StripeCollection<PayoutMethod> list()
                                    throws StripeException

List objects that adhere to the PayoutMethod interface.

Throws:

StripeException

list

public StripeCollection<PayoutMethod> list(PayoutMethodListParams params,
 RequestOptions options)
                                    throws StripeException

List objects that adhere to the PayoutMethod interface.

Throws:

StripeException

retrieve

public PayoutMethod retrieve(String id)
                      throws StripeException,
InvalidPayoutMethodException

Retrieve a PayoutMethod object.

Throws:

StripeException

InvalidPayoutMethodException

retrieve

public PayoutMethod retrieve(String id,
 RequestOptions options)
                      throws StripeException,
InvalidPayoutMethodException

Retrieve a PayoutMethod object.

Throws:

StripeException

InvalidPayoutMethodException

archive

public PayoutMethod archive(String id)
                     throws StripeException,
CannotProceedException,
InvalidPayoutMethodException,
ControlledByAlternateResourceException

Archive a PayoutMethod. Archiving prevents the Payout Method from being used for outbound payments or transfers and omits it from normal list results. To restore list visibility, use the unarchive endpoint.

Throws:

StripeException

CannotProceedException

InvalidPayoutMethodException

ControlledByAlternateResourceException

archive

public PayoutMethod archive(String id,
 RequestOptions options)
                     throws StripeException,
CannotProceedException,
InvalidPayoutMethodException,
ControlledByAlternateResourceException

Archive a PayoutMethod. Archiving prevents the Payout Method from being used for outbound payments or transfers and omits it from normal list results. To restore list visibility, use the unarchive endpoint.

Throws:

StripeException

CannotProceedException

InvalidPayoutMethodException

ControlledByAlternateResourceException

unarchive

public PayoutMethod unarchive(String id)
                       throws StripeException,
InvalidPayoutMethodException,
ControlledByAlternateResourceException

Unarchive a PayoutMethod. Unarchiving restores the Payout Method to normal list results and clears only its archived state. It doesn't guarantee that the Payout Method can be used.

Throws:

StripeException

InvalidPayoutMethodException

ControlledByAlternateResourceException

unarchive

public PayoutMethod unarchive(String id,
 RequestOptions options)
                       throws StripeException,
InvalidPayoutMethodException,
ControlledByAlternateResourceException

Unarchive a PayoutMethod. Unarchiving restores the Payout Method to normal list results and clears only its archived state. It doesn't guarantee that the Payout Method can be used.

Throws:

StripeException

InvalidPayoutMethodException

ControlledByAlternateResourceException