Package com.stripe.service

Class PayoutService

java.lang.Object

com.stripe.net.ApiService

com.stripe.service.PayoutService

public final class PayoutService
extends ApiService

Constructor Summary

Constructors

Constructor	Description
PayoutService(StripeResponseGetter responseGetter)

Method Summary

Modifier and Type	Method	Description
Payout	cancel(String payout)	You can cancel a previously created payout if its status is pending.
Payout	cancel(String payout, RequestOptions options)	You can cancel a previously created payout if its status is pending.
Payout	cancel(String payout, PayoutCancelParams params)	You can cancel a previously created payout if its status is pending.
Payout	cancel(String payout, PayoutCancelParams params, RequestOptions options)	You can cancel a previously created payout if its status is pending.
Payout	create(PayoutCreateParams params)	To send funds to your own bank account, create a new payout object.
Payout	create(PayoutCreateParams params, RequestOptions options)	To send funds to your own bank account, create a new payout object.
StripeCollection<Payout>	list()	Returns a list of existing payouts sent to third-party bank accounts or payouts that Stripe sent to you.
StripeCollection<Payout>	list(RequestOptions options)	Returns a list of existing payouts sent to third-party bank accounts or payouts that Stripe sent to you.
StripeCollection<Payout>	list(PayoutListParams params)	Returns a list of existing payouts sent to third-party bank accounts or payouts that Stripe sent to you.
StripeCollection<Payout>	list(PayoutListParams params, RequestOptions options)	Returns a list of existing payouts sent to third-party bank accounts or payouts that Stripe sent to you.
Payout	retrieve(String payout)	Retrieves the details of an existing payout.
Payout	retrieve(String payout, RequestOptions options)	Retrieves the details of an existing payout.
Payout	retrieve(String payout, PayoutRetrieveParams params)	Retrieves the details of an existing payout.
Payout	retrieve(String payout, PayoutRetrieveParams params, RequestOptions options)	Retrieves the details of an existing payout.
Payout	reverse(String payout)	Reverses a payout by debiting the destination bank account.
Payout	reverse(String payout, RequestOptions options)	Reverses a payout by debiting the destination bank account.
Payout	reverse(String payout, PayoutReverseParams params)	Reverses a payout by debiting the destination bank account.
Payout	reverse(String payout, PayoutReverseParams params, RequestOptions options)	Reverses a payout by debiting the destination bank account.
Payout	update(String payout)	Updates the specified payout by setting the values of the parameters you pass.
Payout	update(String payout, RequestOptions options)	Updates the specified payout by setting the values of the parameters you pass.
Payout	update(String payout, PayoutUpdateParams params)	Updates the specified payout by setting the values of the parameters you pass.
Payout	update(String payout, PayoutUpdateParams params, RequestOptions options)	Updates the specified payout by setting the values of the parameters you pass.

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

PayoutService

public PayoutService(StripeResponseGetter responseGetter)

Method Details

list

public StripeCollection<Payout> list(PayoutListParams params)
                              throws StripeException

Returns a list of existing payouts sent to third-party bank accounts or payouts that Stripe sent to you. The payouts return in sorted order, with the most recently created payouts appearing first.

Throws:

StripeException

list

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

Returns a list of existing payouts sent to third-party bank accounts or payouts that Stripe sent to you. The payouts return in sorted order, with the most recently created payouts appearing first.

Throws:

StripeException

list

public StripeCollection<Payout> list()
                              throws StripeException

Returns a list of existing payouts sent to third-party bank accounts or payouts that Stripe sent to you. The payouts return in sorted order, with the most recently created payouts appearing first.

Throws:

StripeException

list

public StripeCollection<Payout> list(PayoutListParams params,
 RequestOptions options)
                              throws StripeException

Returns a list of existing payouts sent to third-party bank accounts or payouts that Stripe sent to you. The payouts return in sorted order, with the most recently created payouts appearing first.

Throws:

StripeException

create

public Payout create(PayoutCreateParams params)
              throws StripeException

To send funds to your own bank account, create a new payout object. Your Stripe balance must cover the payout amount. If it doesn’t, you receive an “Insufficient Funds” error.

If your API key is in test mode, money won’t actually be sent, though every other action occurs as if you’re in live mode.

If you create a manual payout on a Stripe account that uses multiple payment source types, you need to specify the source type balance that the payout draws from. The balance object details available and pending amounts by source type.

Throws:

StripeException

create

public Payout create(PayoutCreateParams params,
 RequestOptions options)
              throws StripeException

To send funds to your own bank account, create a new payout object. Your Stripe balance must cover the payout amount. If it doesn’t, you receive an “Insufficient Funds” error.

If your API key is in test mode, money won’t actually be sent, though every other action occurs as if you’re in live mode.

If you create a manual payout on a Stripe account that uses multiple payment source types, you need to specify the source type balance that the payout draws from. The balance object details available and pending amounts by source type.

Throws:

StripeException

retrieve

public Payout retrieve(String payout,
 PayoutRetrieveParams params)
                throws StripeException

Retrieves the details of an existing payout. Supply the unique payout ID from either a payout creation request or the payout list. Stripe returns the corresponding payout information.

Throws:

StripeException

retrieve

public Payout retrieve(String payout,
 RequestOptions options)
                throws StripeException

Retrieves the details of an existing payout. Supply the unique payout ID from either a payout creation request or the payout list. Stripe returns the corresponding payout information.

Throws:

StripeException

retrieve

public Payout retrieve(String payout)
                throws StripeException

Retrieves the details of an existing payout. Supply the unique payout ID from either a payout creation request or the payout list. Stripe returns the corresponding payout information.

Throws:

StripeException

retrieve

public Payout retrieve(String payout,
 PayoutRetrieveParams params,
 RequestOptions options)
                throws StripeException

Retrieves the details of an existing payout. Supply the unique payout ID from either a payout creation request or the payout list. Stripe returns the corresponding payout information.

Throws:

StripeException

update

public Payout update(String payout,
 PayoutUpdateParams params)
              throws StripeException

Updates the specified payout by setting the values of the parameters you pass. We don’t change parameters that you don’t provide. This request only accepts the metadata as arguments.

Throws:

StripeException

update

public Payout update(String payout,
 RequestOptions options)
              throws StripeException

Updates the specified payout by setting the values of the parameters you pass. We don’t change parameters that you don’t provide. This request only accepts the metadata as arguments.

Throws:

StripeException

update

public Payout update(String payout)
              throws StripeException

Updates the specified payout by setting the values of the parameters you pass. We don’t change parameters that you don’t provide. This request only accepts the metadata as arguments.

Throws:

StripeException

update

public Payout update(String payout,
 PayoutUpdateParams params,
 RequestOptions options)
              throws StripeException

Updates the specified payout by setting the values of the parameters you pass. We don’t change parameters that you don’t provide. This request only accepts the metadata as arguments.

Throws:

StripeException

cancel

public Payout cancel(String payout,
 PayoutCancelParams params)
              throws StripeException

You can cancel a previously created payout if its status is pending. Stripe refunds the funds to your available balance. You can’t cancel automatic Stripe payouts.

Throws:

StripeException

cancel

public Payout cancel(String payout,
 RequestOptions options)
              throws StripeException

You can cancel a previously created payout if its status is pending. Stripe refunds the funds to your available balance. You can’t cancel automatic Stripe payouts.

Throws:

StripeException

cancel

public Payout cancel(String payout)
              throws StripeException

You can cancel a previously created payout if its status is pending. Stripe refunds the funds to your available balance. You can’t cancel automatic Stripe payouts.

Throws:

StripeException

cancel

public Payout cancel(String payout,
 PayoutCancelParams params,
 RequestOptions options)
              throws StripeException

You can cancel a previously created payout if its status is pending. Stripe refunds the funds to your available balance. You can’t cancel automatic Stripe payouts.

Throws:

StripeException

reverse

public Payout reverse(String payout,
 PayoutReverseParams params)
               throws StripeException

Reverses a payout by debiting the destination bank account. At this time, you can only reverse payouts for connected accounts to US bank accounts. If the payout is manual and in the pending status, use /v1/payouts/:id/cancel instead.

By requesting a reversal through /v1/payouts/:id/reverse, you confirm that the authorized signatory of the selected bank account authorizes the debit on the bank account and that no other authorization is required.

Throws:

StripeException

reverse

public Payout reverse(String payout,
 RequestOptions options)
               throws StripeException

Reverses a payout by debiting the destination bank account. At this time, you can only reverse payouts for connected accounts to US bank accounts. If the payout is manual and in the pending status, use /v1/payouts/:id/cancel instead.

By requesting a reversal through /v1/payouts/:id/reverse, you confirm that the authorized signatory of the selected bank account authorizes the debit on the bank account and that no other authorization is required.

Throws:

StripeException

reverse

public Payout reverse(String payout)
               throws StripeException

Reverses a payout by debiting the destination bank account. At this time, you can only reverse payouts for connected accounts to US bank accounts. If the payout is manual and in the pending status, use /v1/payouts/:id/cancel instead.

By requesting a reversal through /v1/payouts/:id/reverse, you confirm that the authorized signatory of the selected bank account authorizes the debit on the bank account and that no other authorization is required.

Throws:

StripeException

reverse

public Payout reverse(String payout,
 PayoutReverseParams params,
 RequestOptions options)
               throws StripeException

Reverses a payout by debiting the destination bank account. At this time, you can only reverse payouts for connected accounts to US bank accounts. If the payout is manual and in the pending status, use /v1/payouts/:id/cancel instead.

By requesting a reversal through /v1/payouts/:id/reverse, you confirm that the authorized signatory of the selected bank account authorizes the debit on the bank account and that no other authorization is required.

Throws:

StripeException