Class Payout
- java.lang.Object
-
- com.stripe.model.StripeObject
-
- com.stripe.net.ApiResource
-
- com.stripe.model.Payout
-
- All Implemented Interfaces:
BalanceTransactionSource
,HasId
,MetadataStore<Payout>
,StripeObjectInterface
public class Payout extends ApiResource implements MetadataStore<Payout>, BalanceTransactionSource
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class com.stripe.net.ApiResource
ApiResource.RequestMethod
-
-
Field Summary
-
Fields inherited from class com.stripe.net.ApiResource
CHARSET, GSON
-
Fields inherited from class com.stripe.model.StripeObject
PRETTY_PRINT_GSON
-
-
Constructor Summary
Constructors Constructor Description Payout()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description Payout
cancel()
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.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(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.protected boolean
canEqual(java.lang.Object other)
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.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.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()
Returnstrue
if the payout was created by an automated payout schedule, andfalse
if it was requested manually.java.lang.String
getBalanceTransaction()
Get ID of expandablebalanceTransaction
object.BalanceTransaction
getBalanceTransactionObject()
Get expandedbalanceTransaction
.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 expandabledestination
object.ExternalAccount
getDestinationObject()
Get expandeddestination
.java.lang.String
getFailureBalanceTransaction()
Get ID of expandablefailureBalanceTransaction
object.BalanceTransaction
getFailureBalanceTransactionObject()
Get expandedfailureBalanceTransaction
.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 valuetrue
if the object exists in live mode or the valuefalse
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 bestandard
orinstant
.java.lang.String
getObject()
String representing the object's type.java.lang.String
getOriginalPayout()
Get ID of expandableoriginalPayout
object.Payout
getOriginalPayoutObject()
Get expandedoriginalPayout
.java.lang.String
getReversedBy()
Get ID of expandablereversedBy
object.Payout
getReversedByObject()
Get expandedreversedBy
.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
orfailed
.java.lang.String
getType()
Can bebank_account
orcard
.int
hashCode()
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 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 Payout
retrieve(java.lang.String payout)
Retrieves the details of an existing payout.static Payout
retrieve(java.lang.String payout, 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, java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options)
Retrieves the details of an existing payout.Payout
reverse()
Reverses a payout by debiting the destination bank account.Payout
reverse(RequestOptions options)
Reverses a payout by debiting the destination bank account.Payout
reverse(PayoutReverseParams params)
Reverses a payout by debiting the destination bank account.Payout
reverse(PayoutReverseParams params, RequestOptions options)
Reverses a payout by debiting the destination bank account.Payout
reverse(java.util.Map<java.lang.String,java.lang.Object> params)
Reverses a payout by debiting the destination bank account.Payout
reverse(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options)
Reverses a payout by debiting the destination bank account.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)
Returnstrue
if the payout was created by an automated payout schedule, andfalse
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 valuetrue
if the object exists in live mode or the valuefalse
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 bestandard
orinstant
.void
setObject(java.lang.String object)
String representing the object's type.void
setOriginalPayout(java.lang.String id)
void
setOriginalPayoutObject(Payout expandableObject)
void
setReversedBy(java.lang.String id)
void
setReversedByObject(Payout expandableObject)
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
orfailed
.void
setType(java.lang.String type)
Can bebank_account
orcard
.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.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.-
Methods inherited from class com.stripe.net.ApiResource
checkNullTypedParams, classUrl, classUrl, instanceUrl, instanceUrl, request, request, requestCollection, requestCollection, requestSearchResult, requestSearchResult, requestStream, requestStream, setExpandableFieldId, setStripeResponseGetter, singleClassUrl, singleClassUrl, subresourceUrl, urlEncode, urlEncodeId
-
Methods inherited from class com.stripe.model.StripeObject
equals, getLastResponse, getRawJsonObject, setLastResponse, toJson, toString
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface com.stripe.model.StripeObjectInterface
getLastResponse, setLastResponse
-
-
-
-
Method Detail
-
getBalanceTransaction
public java.lang.String getBalanceTransaction()
Get ID of expandablebalanceTransaction
object.
-
setBalanceTransaction
public void setBalanceTransaction(java.lang.String id)
-
getBalanceTransactionObject
public BalanceTransaction getBalanceTransactionObject()
Get expandedbalanceTransaction
.
-
setBalanceTransactionObject
public void setBalanceTransactionObject(BalanceTransaction expandableObject)
-
getDestination
public java.lang.String getDestination()
Get ID of expandabledestination
object.
-
setDestination
public void setDestination(java.lang.String id)
-
getDestinationObject
public ExternalAccount getDestinationObject()
Get expandeddestination
.
-
setDestinationObject
public void setDestinationObject(ExternalAccount expandableObject)
-
getFailureBalanceTransaction
public java.lang.String getFailureBalanceTransaction()
Get ID of expandablefailureBalanceTransaction
object.
-
setFailureBalanceTransaction
public void setFailureBalanceTransaction(java.lang.String id)
-
getFailureBalanceTransactionObject
public BalanceTransaction getFailureBalanceTransactionObject()
Get expandedfailureBalanceTransaction
.
-
setFailureBalanceTransactionObject
public void setFailureBalanceTransactionObject(BalanceTransaction expandableObject)
-
getOriginalPayout
public java.lang.String getOriginalPayout()
Get ID of expandableoriginalPayout
object.
-
setOriginalPayout
public void setOriginalPayout(java.lang.String id)
-
getOriginalPayoutObject
public Payout getOriginalPayoutObject()
Get expandedoriginalPayout
.
-
setOriginalPayoutObject
public void setOriginalPayoutObject(Payout expandableObject)
-
getReversedBy
public java.lang.String getReversedBy()
Get ID of expandablereversedBy
object.
-
setReversedBy
public void setReversedBy(java.lang.String id)
-
getReversedByObject
public Payout getReversedByObject()
Get expandedreversedBy
.
-
setReversedByObject
public void setReversedByObject(Payout expandableObject)
-
retrieve
public static Payout retrieve(java.lang.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, and Stripe will return the corresponding payout information.- Throws:
StripeException
-
retrieve
public static Payout retrieve(java.lang.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, and Stripe will return the corresponding payout information.- Throws:
StripeException
-
retrieve
public static Payout retrieve(java.lang.String payout, java.util.Map<java.lang.String,java.lang.Object> 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, and Stripe will return the corresponding payout information.- Throws:
StripeException
-
retrieve
public static Payout retrieve(java.lang.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, and Stripe will return the corresponding payout information.- Throws:
StripeException
-
list
public static PayoutCollection list(java.util.Map<java.lang.String,java.lang.Object> params) throws StripeException
Returns a list of existing payouts sent to third-party bank accounts or that Stripe has sent you. The payouts are returned in sorted order, with the most recently created payouts appearing first.- Throws:
StripeException
-
list
public static PayoutCollection list(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options) throws StripeException
Returns a list of existing payouts sent to third-party bank accounts or that Stripe has sent you. The payouts are returned in sorted order, with the most recently created payouts appearing first.- Throws:
StripeException
-
list
public static PayoutCollection list(PayoutListParams params) throws StripeException
Returns a list of existing payouts sent to third-party bank accounts or that Stripe has sent you. The payouts are returned in sorted order, with the most recently created payouts appearing first.- Throws:
StripeException
-
list
public static PayoutCollection list(PayoutListParams params, RequestOptions options) throws StripeException
Returns a list of existing payouts sent to third-party bank accounts or that Stripe has sent you. The payouts are returned in sorted order, with the most recently created payouts appearing first.- Throws:
StripeException
-
create
public static Payout create(java.util.Map<java.lang.String,java.lang.Object> params) throws StripeException
To send funds to your own bank account, you create a new payout object. Your Stripe balance must be able to cover the payout amount, or you’ll receive an “Insufficient Funds” error.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.
- Throws:
StripeException
-
create
public static Payout create(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options) throws StripeException
To send funds to your own bank account, you create a new payout object. Your Stripe balance must be able to cover the payout amount, or you’ll receive an “Insufficient Funds” error.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.
- Throws:
StripeException
-
create
public static Payout create(PayoutCreateParams params) throws StripeException
To send funds to your own bank account, you create a new payout object. Your Stripe balance must be able to cover the payout amount, or you’ll receive an “Insufficient Funds” error.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.
- Throws:
StripeException
-
create
public static Payout create(PayoutCreateParams params, RequestOptions options) throws StripeException
To send funds to your own bank account, you create a new payout object. Your Stripe balance must be able to cover the payout amount, or you’ll receive an “Insufficient Funds” error.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.
- Throws:
StripeException
-
update
public Payout update(java.util.Map<java.lang.String,java.lang.Object> params) throws StripeException
Updates the specified payout by setting the values of the parameters passed. Any parameters not provided will be left unchanged. This request accepts only the metadata as arguments.- Specified by:
update
in interfaceMetadataStore<Payout>
- Throws:
StripeException
-
update
public Payout update(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options) throws StripeException
Updates the specified payout by setting the values of the parameters passed. Any parameters not provided will be left unchanged. This request accepts only the metadata as arguments.- Specified by:
update
in interfaceMetadataStore<Payout>
- Throws:
StripeException
-
update
public Payout update(PayoutUpdateParams params) throws StripeException
Updates the specified payout by setting the values of the parameters passed. Any parameters not provided will be left unchanged. This request accepts only the metadata as arguments.- Throws:
StripeException
-
update
public Payout update(PayoutUpdateParams params, RequestOptions options) throws StripeException
Updates the specified payout by setting the values of the parameters passed. Any parameters not provided will be left unchanged. This request accepts only the metadata as arguments.- Throws:
StripeException
-
cancel
public Payout cancel() throws StripeException
A previously created payout can be canceled if it has not yet been paid out. Funds will be refunded to your available balance. You may not cancel automatic Stripe payouts.- Throws:
StripeException
-
cancel
public Payout cancel(RequestOptions options) throws StripeException
A previously created payout can be canceled if it has not yet been paid out. Funds will be refunded to your available balance. You may not cancel automatic Stripe payouts.- Throws:
StripeException
-
cancel
public Payout cancel(java.util.Map<java.lang.String,java.lang.Object> params) throws StripeException
A previously created payout can be canceled if it has not yet been paid out. Funds will be refunded to your available balance. You may not cancel automatic Stripe payouts.- Throws:
StripeException
-
cancel
public Payout cancel(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options) throws StripeException
A previously created payout can be canceled if it has not yet been paid out. Funds will be refunded to your available balance. You may not cancel automatic Stripe payouts.- Throws:
StripeException
-
cancel
public Payout cancel(PayoutCancelParams params) throws StripeException
A previously created payout can be canceled if it has not yet been paid out. Funds will be refunded to your available balance. You may not cancel automatic Stripe payouts.- Throws:
StripeException
-
cancel
public Payout cancel(PayoutCancelParams params, RequestOptions options) throws StripeException
A previously created payout can be canceled if it has not yet been paid out. Funds will be refunded to your available balance. You may not cancel automatic Stripe payouts.- Throws:
StripeException
-
reverse
public Payout reverse() throws StripeException
Reverses a payout by debiting the destination bank account. Only payouts for connected accounts to US bank accounts may be reversed at this time. If the payout is in thepending
status,/v1/payouts/:id/cancel
should be used instead.By requesting a reversal via
/v1/payouts/:id/reverse
, you confirm that the authorized signatory of the selected bank account has authorized the debit on the bank account and that no other authorization is required.- Throws:
StripeException
-
reverse
public Payout reverse(RequestOptions options) throws StripeException
Reverses a payout by debiting the destination bank account. Only payouts for connected accounts to US bank accounts may be reversed at this time. If the payout is in thepending
status,/v1/payouts/:id/cancel
should be used instead.By requesting a reversal via
/v1/payouts/:id/reverse
, you confirm that the authorized signatory of the selected bank account has authorized the debit on the bank account and that no other authorization is required.- Throws:
StripeException
-
reverse
public Payout reverse(java.util.Map<java.lang.String,java.lang.Object> params) throws StripeException
Reverses a payout by debiting the destination bank account. Only payouts for connected accounts to US bank accounts may be reversed at this time. If the payout is in thepending
status,/v1/payouts/:id/cancel
should be used instead.By requesting a reversal via
/v1/payouts/:id/reverse
, you confirm that the authorized signatory of the selected bank account has authorized the debit on the bank account and that no other authorization is required.- Throws:
StripeException
-
reverse
public Payout reverse(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options) throws StripeException
Reverses a payout by debiting the destination bank account. Only payouts for connected accounts to US bank accounts may be reversed at this time. If the payout is in thepending
status,/v1/payouts/:id/cancel
should be used instead.By requesting a reversal via
/v1/payouts/:id/reverse
, you confirm that the authorized signatory of the selected bank account has authorized the debit on the bank account and that no other authorization is required.- Throws:
StripeException
-
reverse
public Payout reverse(PayoutReverseParams params) throws StripeException
Reverses a payout by debiting the destination bank account. Only payouts for connected accounts to US bank accounts may be reversed at this time. If the payout is in thepending
status,/v1/payouts/:id/cancel
should be used instead.By requesting a reversal via
/v1/payouts/:id/reverse
, you confirm that the authorized signatory of the selected bank account has authorized the debit on the bank account and that no other authorization is required.- Throws:
StripeException
-
reverse
public Payout reverse(PayoutReverseParams params, RequestOptions options) throws StripeException
Reverses a payout by debiting the destination bank account. Only payouts for connected accounts to US bank accounts may be reversed at this time. If the payout is in thepending
status,/v1/payouts/:id/cancel
should be used instead.By requesting a reversal via
/v1/payouts/:id/reverse
, you confirm that the authorized signatory of the selected bank account has authorized the debit on the bank account and that no other authorization is required.- Throws:
StripeException
-
getAmount
public java.lang.Long getAmount()
Amount (in %s) to be transferred to your bank account or debit card.
-
getArrivalDate
public java.lang.Long getArrivalDate()
Date the payout is expected to arrive in the bank. This factors in delays like weekends or bank holidays.
-
getAutomatic
public java.lang.Boolean getAutomatic()
Returnstrue
if the payout was created by an automated payout schedule, andfalse
if it was requested manually.
-
getCreated
public java.lang.Long getCreated()
Time at which the object was created. Measured in seconds since the Unix epoch.
-
getCurrency
public java.lang.String getCurrency()
Three-letter ISO currency code, in lowercase. Must be a supported currency.
-
getDescription
public java.lang.String getDescription()
An arbitrary string attached to the object. Often useful for displaying to users.
-
getFailureCode
public java.lang.String getFailureCode()
Error code explaining reason for payout failure if available. See Types of payout failures for a list of failure codes.
-
getFailureMessage
public java.lang.String getFailureMessage()
Message to user further explaining reason for payout failure if available.
-
getLivemode
public java.lang.Boolean getLivemode()
Has the valuetrue
if the object exists in live mode or the valuefalse
if the object exists in test mode.
-
getMethod
public java.lang.String getMethod()
The method used to send this payout, which can bestandard
orinstant
.instant
is only supported for payouts to debit cards. (See Instant payouts for marketplaces for more information.)
-
getObject
public java.lang.String getObject()
String representing the object's type. Objects of the same type share the same value.Equal to
payout
.
-
getSourceType
public java.lang.String getSourceType()
The source balance this payout came from. One ofcard
,fpx
, orbank_account
.
-
getStatementDescriptor
public java.lang.String getStatementDescriptor()
Extra information about a payout to be displayed on the user's bank statement.
-
getStatus
public java.lang.String getStatus()
Current status of the payout:paid
,pending
,in_transit
,canceled
orfailed
. A payout ispending
until it is submitted to the bank, when it becomesin_transit
. The status then changes topaid
if the transaction goes through, or tofailed
orcanceled
(within 5 business days). Some failed payouts may initially show aspaid
but then change tofailed
.
-
getType
public java.lang.String getType()
Can bebank_account
orcard
.
-
setAmount
public void setAmount(java.lang.Long amount)
Amount (in %s) to be transferred to your bank account or debit card.
-
setArrivalDate
public void setArrivalDate(java.lang.Long arrivalDate)
Date the payout is expected to arrive in the bank. This factors in delays like weekends or bank holidays.
-
setAutomatic
public void setAutomatic(java.lang.Boolean automatic)
Returnstrue
if the payout was created by an automated payout schedule, andfalse
if it was requested manually.
-
setCreated
public void setCreated(java.lang.Long created)
Time at which the object was created. Measured in seconds since the Unix epoch.
-
setCurrency
public void setCurrency(java.lang.String currency)
Three-letter ISO currency code, in lowercase. Must be a supported currency.
-
setDescription
public void setDescription(java.lang.String description)
An arbitrary string attached to the object. Often useful for displaying to users.
-
setFailureCode
public void setFailureCode(java.lang.String failureCode)
Error code explaining reason for payout failure if available. See Types of payout failures for a list of failure codes.
-
setFailureMessage
public void setFailureMessage(java.lang.String failureMessage)
Message to user further explaining reason for payout failure if available.
-
setId
public void setId(java.lang.String id)
Unique identifier for the object.
-
setLivemode
public void setLivemode(java.lang.Boolean livemode)
Has the valuetrue
if the object exists in live mode or the valuefalse
if the object exists in test mode.
-
setMetadata
public void setMetadata(java.util.Map<java.lang.String,java.lang.String> metadata)
Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
-
setMethod
public void setMethod(java.lang.String method)
The method used to send this payout, which can bestandard
orinstant
.instant
is only supported for payouts to debit cards. (See Instant payouts for marketplaces for more information.)
-
setObject
public void setObject(java.lang.String object)
String representing the object's type. Objects of the same type share the same value.Equal to
payout
.
-
setSourceType
public void setSourceType(java.lang.String sourceType)
The source balance this payout came from. One ofcard
,fpx
, orbank_account
.
-
setStatementDescriptor
public void setStatementDescriptor(java.lang.String statementDescriptor)
Extra information about a payout to be displayed on the user's bank statement.
-
setStatus
public void setStatus(java.lang.String status)
Current status of the payout:paid
,pending
,in_transit
,canceled
orfailed
. A payout ispending
until it is submitted to the bank, when it becomesin_transit
. The status then changes topaid
if the transaction goes through, or tofailed
orcanceled
(within 5 business days). Some failed payouts may initially show aspaid
but then change tofailed
.
-
setType
public void setType(java.lang.String type)
Can bebank_account
orcard
.
-
equals
public boolean equals(java.lang.Object o)
- Overrides:
equals
in classjava.lang.Object
-
canEqual
protected boolean canEqual(java.lang.Object other)
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classjava.lang.Object
-
getId
public java.lang.String getId()
Unique identifier for the object.
-
getMetadata
public java.util.Map<java.lang.String,java.lang.String> getMetadata()
Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.- Specified by:
getMetadata
in interfaceMetadataStore<Payout>
-
-