public class Payout extends ApiResource implements MetadataStore<Payout>, BalanceTransactionSource
ApiResource.RequestMethod
CHARSET, GSON
PRETTY_PRINT_GSON
Constructor and Description |
---|
Payout() |
Modifier and Type | Method and Description |
---|---|
Payout |
cancel()
A previously created payout can be canceled if it has not yet been paid out.
|
Payout |
cancel(java.util.Map<java.lang.String,java.lang.Object> params)
A previously created payout can be canceled if it has not yet been paid out.
|
Payout |
cancel(java.util.Map<java.lang.String,java.lang.Object> params,
RequestOptions options)
A previously created payout can be canceled if it has not yet been paid out.
|
Payout |
cancel(PayoutCancelParams params)
A previously created payout can be canceled if it has not yet been paid out.
|
Payout |
cancel(PayoutCancelParams params,
RequestOptions options)
A previously created payout can be canceled if it has not yet been paid out.
|
Payout |
cancel(RequestOptions options)
A previously created payout can be canceled if it has not yet been paid out.
|
protected boolean |
canEqual(java.lang.Object other) |
static Payout |
create(java.util.Map<java.lang.String,java.lang.Object> params)
To send funds to your own bank account, you create a new payout object.
|
static Payout |
create(java.util.Map<java.lang.String,java.lang.Object> params,
RequestOptions options)
To send funds to your own bank account, you create a new payout object.
|
static Payout |
create(PayoutCreateParams params)
To send funds to your own bank account, you create a new payout object.
|
static Payout |
create(PayoutCreateParams params,
RequestOptions options)
To send funds to your own bank account, you create a new payout object.
|
boolean |
equals(java.lang.Object o) |
java.lang.Long |
getAmount()
Amount (in %s) to be transferred to your bank account or debit card.
|
java.lang.Long |
getArrivalDate()
Date the payout is expected to arrive in the bank.
|
java.lang.Boolean |
getAutomatic()
Returns
true if the payout was created by an automated payout schedule, and
false if it was requested
manually. |
java.lang.String |
getBalanceTransaction()
Get ID of expandable
balanceTransaction object. |
BalanceTransaction |
getBalanceTransactionObject()
Get expanded
balanceTransaction . |
java.lang.Long |
getCreated()
Time at which the object was created.
|
java.lang.String |
getCurrency()
Three-letter ISO currency code,
in lowercase.
|
java.lang.String |
getDescription()
An arbitrary string attached to the object.
|
java.lang.String |
getDestination()
Get ID of expandable
destination object. |
ExternalAccount |
getDestinationObject()
Get expanded
destination . |
java.lang.String |
getFailureBalanceTransaction()
Get ID of expandable
failureBalanceTransaction object. |
BalanceTransaction |
getFailureBalanceTransactionObject()
Get expanded
failureBalanceTransaction . |
java.lang.String |
getFailureCode()
Error code explaining reason for payout failure if available.
|
java.lang.String |
getFailureMessage()
Message to user further explaining reason for payout failure if available.
|
java.lang.String |
getId()
Unique identifier for the object.
|
java.lang.Boolean |
getLivemode()
Has the value
true if the object exists in live mode or the value false if the
object exists in test mode. |
java.util.Map<java.lang.String,java.lang.String> |
getMetadata()
Set of key-value pairs that you can attach to an object.
|
java.lang.String |
getMethod()
The method used to send this payout, which can be
standard or instant . |
java.lang.String |
getObject()
String representing the object's type.
|
java.lang.String |
getSourceType()
The source balance this payout came from.
|
java.lang.String |
getStatementDescriptor()
Extra information about a payout to be displayed on the user's bank statement.
|
java.lang.String |
getStatus()
Current status of the payout:
paid , pending , in_transit , canceled or failed . |
java.lang.String |
getType()
Can be
bank_account or card . |
int |
hashCode() |
static PayoutCollection |
list(java.util.Map<java.lang.String,java.lang.Object> params)
Returns a list of existing payouts sent to third-party bank accounts or that Stripe has sent
you.
|
static PayoutCollection |
list(java.util.Map<java.lang.String,java.lang.Object> params,
RequestOptions options)
Returns a list of existing payouts sent to third-party bank accounts or that Stripe has sent
you.
|
static PayoutCollection |
list(PayoutListParams params)
Returns a list of existing payouts sent to third-party bank accounts or that Stripe has sent
you.
|
static PayoutCollection |
list(PayoutListParams params,
RequestOptions options)
Returns a list of existing payouts sent to third-party bank accounts or that Stripe has sent
you.
|
static Payout |
retrieve(java.lang.String payout)
Retrieves the details of an existing payout.
|
static Payout |
retrieve(java.lang.String payout,
java.util.Map<java.lang.String,java.lang.Object> params,
RequestOptions options)
Retrieves the details of an existing payout.
|
static Payout |
retrieve(java.lang.String payout,
PayoutRetrieveParams params,
RequestOptions options)
Retrieves the details of an existing payout.
|
static Payout |
retrieve(java.lang.String payout,
RequestOptions options)
Retrieves the details of an existing payout.
|
void |
setAmount(java.lang.Long amount)
Amount (in %s) to be transferred to your bank account or debit card.
|
void |
setArrivalDate(java.lang.Long arrivalDate)
Date the payout is expected to arrive in the bank.
|
void |
setAutomatic(java.lang.Boolean automatic)
Returns
true if the payout was created by an automated payout schedule, and
false if it was requested
manually. |
void |
setBalanceTransaction(java.lang.String id) |
void |
setBalanceTransactionObject(BalanceTransaction expandableObject) |
void |
setCreated(java.lang.Long created)
Time at which the object was created.
|
void |
setCurrency(java.lang.String currency)
Three-letter ISO currency code,
in lowercase.
|
void |
setDescription(java.lang.String description)
An arbitrary string attached to the object.
|
void |
setDestination(java.lang.String id) |
void |
setDestinationObject(ExternalAccount expandableObject) |
void |
setFailureBalanceTransaction(java.lang.String id) |
void |
setFailureBalanceTransactionObject(BalanceTransaction expandableObject) |
void |
setFailureCode(java.lang.String failureCode)
Error code explaining reason for payout failure if available.
|
void |
setFailureMessage(java.lang.String failureMessage)
Message to user further explaining reason for payout failure if available.
|
void |
setId(java.lang.String id)
Unique identifier for the object.
|
void |
setLivemode(java.lang.Boolean livemode)
Has the value
true if the object exists in live mode or the value false if the
object exists in test mode. |
void |
setMetadata(java.util.Map<java.lang.String,java.lang.String> metadata)
Set of key-value pairs that you can attach to an object.
|
void |
setMethod(java.lang.String method)
The method used to send this payout, which can be
standard or instant . |
void |
setObject(java.lang.String object)
String representing the object's type.
|
void |
setSourceType(java.lang.String sourceType)
The source balance this payout came from.
|
void |
setStatementDescriptor(java.lang.String statementDescriptor)
Extra information about a payout to be displayed on the user's bank statement.
|
void |
setStatus(java.lang.String status)
Current status of the payout:
paid , pending , in_transit , canceled or failed . |
void |
setType(java.lang.String type)
Can be
bank_account or card . |
Payout |
update(java.util.Map<java.lang.String,java.lang.Object> params)
Updates the specified payout by setting the values of the parameters passed.
|
Payout |
update(java.util.Map<java.lang.String,java.lang.Object> params,
RequestOptions options)
Updates the specified payout by setting the values of the parameters passed.
|
Payout |
update(PayoutUpdateParams params)
Updates the specified payout by setting the values of the parameters passed.
|
Payout |
update(PayoutUpdateParams params,
RequestOptions options)
Updates the specified payout by setting the values of the parameters passed.
|
checkNullTypedParams, classUrl, classUrl, instanceUrl, instanceUrl, request, request, requestCollection, requestCollection, setExpandableFieldId, setStripeResponseGetter, singleClassUrl, singleClassUrl, subresourceUrl, urlEncode, urlEncodeId
equals, getLastResponse, getRawJsonObject, setLastResponse, toJson, toString
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
getLastResponse, setLastResponse
public java.lang.String getBalanceTransaction()
balanceTransaction
object.public void setBalanceTransaction(java.lang.String id)
public BalanceTransaction getBalanceTransactionObject()
balanceTransaction
.public void setBalanceTransactionObject(BalanceTransaction expandableObject)
public java.lang.String getDestination()
destination
object.public void setDestination(java.lang.String id)
public ExternalAccount getDestinationObject()
destination
.public void setDestinationObject(ExternalAccount expandableObject)
public java.lang.String getFailureBalanceTransaction()
failureBalanceTransaction
object.public void setFailureBalanceTransaction(java.lang.String id)
public BalanceTransaction getFailureBalanceTransactionObject()
failureBalanceTransaction
.public void setFailureBalanceTransactionObject(BalanceTransaction expandableObject)
public static Payout retrieve(java.lang.String payout) throws StripeException
StripeException
public static Payout retrieve(java.lang.String payout, RequestOptions options) throws StripeException
StripeException
public static Payout retrieve(java.lang.String payout, java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options) throws StripeException
StripeException
public static Payout retrieve(java.lang.String payout, PayoutRetrieveParams params, RequestOptions options) throws StripeException
StripeException
public static PayoutCollection list(java.util.Map<java.lang.String,java.lang.Object> params) throws StripeException
StripeException
public static PayoutCollection list(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options) throws StripeException
StripeException
public static PayoutCollection list(PayoutListParams params) throws StripeException
StripeException
public static PayoutCollection list(PayoutListParams params, RequestOptions options) throws StripeException
StripeException
public static Payout create(java.util.Map<java.lang.String,java.lang.Object> params) throws StripeException
If your API key is in test mode, money won’t actually be sent, though everything else will occur as if in live mode.
If you are creating a manual payout on a Stripe account that uses multiple payment source types, you’ll need to specify the source type balance that the payout should draw from. The balance object details available and pending amounts by source type.
StripeException
public static Payout create(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options) throws StripeException
If your API key is in test mode, money won’t actually be sent, though everything else will occur as if in live mode.
If you are creating a manual payout on a Stripe account that uses multiple payment source types, you’ll need to specify the source type balance that the payout should draw from. The balance object details available and pending amounts by source type.
StripeException
public static Payout create(PayoutCreateParams params) throws StripeException
If your API key is in test mode, money won’t actually be sent, though everything else will occur as if in live mode.
If you are creating a manual payout on a Stripe account that uses multiple payment source types, you’ll need to specify the source type balance that the payout should draw from. The balance object details available and pending amounts by source type.
StripeException
public static Payout create(PayoutCreateParams params, RequestOptions options) throws StripeException
If your API key is in test mode, money won’t actually be sent, though everything else will occur as if in live mode.
If you are creating a manual payout on a Stripe account that uses multiple payment source types, you’ll need to specify the source type balance that the payout should draw from. The balance object details available and pending amounts by source type.
StripeException
public Payout update(java.util.Map<java.lang.String,java.lang.Object> params) throws StripeException
update
in interface MetadataStore<Payout>
StripeException
public Payout update(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options) throws StripeException
update
in interface MetadataStore<Payout>
StripeException
public Payout update(PayoutUpdateParams params) throws StripeException
StripeException
public Payout update(PayoutUpdateParams params, RequestOptions options) throws StripeException
StripeException
public Payout cancel() throws StripeException
StripeException
public Payout cancel(RequestOptions options) throws StripeException
StripeException
public Payout cancel(java.util.Map<java.lang.String,java.lang.Object> params) throws StripeException
StripeException
public Payout cancel(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options) throws StripeException
StripeException
public Payout cancel(PayoutCancelParams params) throws StripeException
StripeException
public Payout cancel(PayoutCancelParams params, RequestOptions options) throws StripeException
StripeException
public java.lang.Long getAmount()
public java.lang.Long getArrivalDate()
public java.lang.Boolean getAutomatic()
true
if the payout was created by an automated payout schedule, and
false
if it was requested
manually.public java.lang.Long getCreated()
public java.lang.String getCurrency()
public java.lang.String getDescription()
public java.lang.String getFailureCode()
public java.lang.String getFailureMessage()
public java.lang.Boolean getLivemode()
true
if the object exists in live mode or the value false
if the
object exists in test mode.public java.lang.String getMethod()
standard
or instant
. instant
is only supported for payouts to debit cards. (See Instant payouts for
marketplaces for more information.)public java.lang.String getObject()
Equal to payout
.
public java.lang.String getSourceType()
card
, fpx
, or bank_account
.public java.lang.String getStatementDescriptor()
public java.lang.String getStatus()
paid
, pending
, in_transit
, canceled
or failed
. A payout is pending
until it is submitted to the bank,
when it becomes in_transit
. The status then changes to paid
if the transaction
goes through, or to failed
or canceled
(within 5 business days). Some failed
payouts may initially show as paid
but then change to failed
.public java.lang.String getType()
bank_account
or card
.public void setAmount(java.lang.Long amount)
public void setArrivalDate(java.lang.Long arrivalDate)
public void setAutomatic(java.lang.Boolean automatic)
true
if the payout was created by an automated payout schedule, and
false
if it was requested
manually.public void setCreated(java.lang.Long created)
public void setCurrency(java.lang.String currency)
public void setDescription(java.lang.String description)
public void setFailureCode(java.lang.String failureCode)
public void setFailureMessage(java.lang.String failureMessage)
public void setId(java.lang.String id)
public void setLivemode(java.lang.Boolean livemode)
true
if the object exists in live mode or the value false
if the
object exists in test mode.public void setMetadata(java.util.Map<java.lang.String,java.lang.String> metadata)
public void setMethod(java.lang.String method)
standard
or instant
. instant
is only supported for payouts to debit cards. (See Instant payouts for
marketplaces for more information.)public void setObject(java.lang.String object)
Equal to payout
.
public void setSourceType(java.lang.String sourceType)
card
, fpx
, or bank_account
.public void setStatementDescriptor(java.lang.String statementDescriptor)
public void setStatus(java.lang.String status)
paid
, pending
, in_transit
, canceled
or failed
. A payout is pending
until it is submitted to the bank,
when it becomes in_transit
. The status then changes to paid
if the transaction
goes through, or to failed
or canceled
(within 5 business days). Some failed
payouts may initially show as paid
but then change to failed
.public void setType(java.lang.String type)
bank_account
or card
.public boolean equals(java.lang.Object o)
equals
in class java.lang.Object
protected boolean canEqual(java.lang.Object other)
public int hashCode()
hashCode
in class java.lang.Object
public java.lang.String getId()
public java.util.Map<java.lang.String,java.lang.String> getMetadata()
getMetadata
in interface MetadataStore<Payout>