com.stripe.model

Class Transfer

java.lang.Object

com.stripe.model.StripeObject

com.stripe.net.APIResource

com.stripe.model.Transfer

All Implemented Interfaces:

HasId, MetadataStore<Transfer>

public class Transfer
extends APIResource
implements MetadataStore<Transfer>, HasId

Nested Class Summary

Nested classes/interfaces inherited from class com.stripe.net.APIResource

APIResource.RequestMethod, APIResource.RequestType

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 and Description
Transfer()

Method Summary

Modifier and Type	Method and Description
static TransferCollection	all(java.util.Map<java.lang.String,java.lang.Object> params) Deprecated. Use the list(Map) method instead. This method will be removed in the next major version.
static TransferCollection	all(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options) Deprecated. Use the list(Map, RequestOptions) method instead. This method will be removed in the next major version.
static TransferCollection	all(java.util.Map<java.lang.String,java.lang.Object> params, java.lang.String apiKey) Deprecated. Use the list(Map, RequestOptions) method instead. This method will be removed in the next major version.
Transfer	cancel() Deprecated. Use the {#link Payout#cancel()} method instead.
Transfer	cancel(RequestOptions options) Deprecated. Use the {#link Payout#cancel(RequestOptions)} method instead.
Transfer	cancel(java.lang.String apiKey) Deprecated. Use the cancel(RequestOptions) method instead. This method will be removed in the next major version.
protected boolean	canEqual(java.lang.Object other)
static Transfer	create(java.util.Map<java.lang.String,java.lang.Object> params) Create a transfer.
static Transfer	create(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options) Create a transfer.
static Transfer	create(java.util.Map<java.lang.String,java.lang.Object> params, java.lang.String apiKey) Deprecated. Use the create(Map, RequestOptions) method instead. This method will be removed in the next major version.
boolean	equals(java.lang.Object o)
BankAccount	getAccount() Deprecated. Prefer using the bankAccount attribute instead.
java.lang.Long	getAmount()
java.lang.Long	getAmountReversed()
java.lang.String	getApplicationFee()
java.lang.String	getBalanceTransaction()
BalanceTransaction	getBalanceTransactionObject()
BankAccount	getBankAccount()
java.lang.Long	getCreated()
java.lang.String	getCurrency()
java.lang.Long	getDate()
java.lang.String	getDescription()
java.lang.String	getDestination()
Account	getDestinationObject()
java.lang.String	getDestinationPayment()
Charge	getDestinationPaymentObject()
java.lang.String	getFailureCode()
java.lang.String	getFailureMessage()
java.lang.String	getId()
java.lang.Boolean	getLivemode()
java.util.Map<java.lang.String,java.lang.String>	getMetadata()
java.lang.String	getObject()
java.util.List<java.lang.String>	getOtherTransfers() Deprecated. Prefer using the BalanceTransaction.list(java.util.Map<java.lang.String, java.lang.Object>) method instead.
java.lang.String	getRecipient() Deprecated.
TransferReversalCollection	getReversals() Returns the reversals list.
java.lang.Boolean	getReversed()
java.lang.String	getSourceTransaction()
Charge	getSourceTransactionObject()
java.lang.String	getSourceType()
java.lang.String	getStatementDescription() Deprecated. Prefer using the statementDescriptor attribute instead.
java.lang.String	getStatementDescriptor()
java.lang.String	getStatus()
Summary	getSummary() Deprecated. Prefer using the BalanceTransaction.list(java.util.Map<java.lang.String, java.lang.Object>) method instead.
java.lang.String	getTransferGroup()
java.lang.String	getType()
int	hashCode()
static TransferCollection	list(java.util.Map<java.lang.String,java.lang.Object> params) List all transfers.
static TransferCollection	list(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options) List all transfers.
static Transfer	retrieve(java.lang.String id) Retrive a transfer.
static Transfer	retrieve(java.lang.String id, java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options) Retrive a transfer.
static Transfer	retrieve(java.lang.String id, RequestOptions options) Retrive a transfer.
static Transfer	retrieve(java.lang.String id, java.lang.String apiKey) Deprecated. Use the retrieve(String, RequestOptions) method instead. This method will be removed in the next major version.
void	setAccount(BankAccount account) Deprecated. Prefer using the bankAccount attribute instead.
void	setAmount(java.lang.Long amount)
void	setAmountReversed(java.lang.Long amountReversed)
void	setApplicationFee(java.lang.String applicationFee)
void	setBalanceTransaction(java.lang.String balanceTransactionID)
void	setBalanceTransactionObject(BalanceTransaction c)
void	setBankAccount(BankAccount bankAccount)
void	setCreated(java.lang.Long created)
void	setCurrency(java.lang.String currency)
void	setDate(java.lang.Long date)
void	setDescription(java.lang.String description)
void	setDestination(java.lang.String destinationID)
void	setDestinationObject(Account c)
void	setDestinationPayment(java.lang.String destinationPaymentID)
void	setDestinationPaymentObject(Charge destinationPayment)
void	setFailureCode(java.lang.String failureCode)
void	setFailureMessage(java.lang.String failureMessage)
void	setId(java.lang.String id)
void	setLivemode(java.lang.Boolean livemode)
void	setMetadata(java.util.Map<java.lang.String,java.lang.String> metadata)
void	setObject(java.lang.String object)
void	setOtherTransfers(java.util.List<java.lang.String> otherTransfers) Deprecated. Prefer using the BalanceTransaction.list(java.util.Map<java.lang.String, java.lang.Object>) method instead.
void	setRecipient(java.lang.String recipient) Deprecated.
void	setReversals(TransferReversalCollection reversals)
void	setReversed(java.lang.Boolean reversed)
void	setSourceTransaction(java.lang.String sourceTransactionID)
void	setSourceTransactionObject(Charge sourceTransaction)
void	setSourceType(java.lang.String sourceType)
void	setStatementDescription(java.lang.String statementDescription) Deprecated. Prefer using the statementDescriptor attribute instead.
void	setStatementDescriptor(java.lang.String statementDescriptor)
void	setStatus(java.lang.String status)
void	setSummary(Summary summary) Deprecated. Prefer using the BalanceTransaction.list(java.util.Map<java.lang.String, java.lang.Object>) method instead.
void	setTransferGroup(java.lang.String transferGroup)
void	setType(java.lang.String type)
TransferTransactionCollection	transactions(java.util.Map<java.lang.String,java.lang.Object> params) Deprecated. Prefer using the BalanceTransaction.list(Map) method with the payout parameter.
TransferTransactionCollection	transactions(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options) Deprecated. Prefer using the BalanceTransaction.list(Map, RequestOptions) method with the payout parameter.
TransferTransactionCollection	transactions(java.util.Map<java.lang.String,java.lang.Object> params, java.lang.String apiKey) Deprecated. Use the transactions(Map, RequestOptions) method instead. This method will be removed in the next major version.
Transfer	update(java.util.Map<java.lang.String,java.lang.Object> params) Update a transfer.
Transfer	update(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options) Update a transfer.
Transfer	update(java.util.Map<java.lang.String,java.lang.Object> params, java.lang.String apiKey) Deprecated. Use the update(Map, RequestOptions) method instead. This method will be removed in the next major version.

Methods inherited from class com.stripe.net.APIResource

classURL, classURL, instanceURL, instanceURL, multipartRequest, request, requestCollection, setExpandableFieldID, setStripeResponseGetter, singleClassURL, singleClassURL, subresourceURL, urlEncode

Methods inherited from class com.stripe.model.StripeObject

equals, getLastResponse, setLastResponse, toJson, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Transfer

public Transfer()

Method Detail

getBalanceTransaction

public java.lang.String getBalanceTransaction()

setBalanceTransaction

public void setBalanceTransaction(java.lang.String balanceTransactionID)

getBalanceTransactionObject

public BalanceTransaction getBalanceTransactionObject()

setBalanceTransactionObject

public void setBalanceTransactionObject(BalanceTransaction c)

getDestination

public java.lang.String getDestination()

setDestination

public void setDestination(java.lang.String destinationID)

getDestinationObject

public Account getDestinationObject()

setDestinationObject

public void setDestinationObject(Account c)

getDestinationPayment

public java.lang.String getDestinationPayment()

setDestinationPayment

public void setDestinationPayment(java.lang.String destinationPaymentID)

getDestinationPaymentObject

public Charge getDestinationPaymentObject()

setDestinationPaymentObject

public void setDestinationPaymentObject(Charge destinationPayment)

getReversals

public TransferReversalCollection getReversals()

Returns the reversals list.

Returns:

the reversals list

getSourceTransaction

public java.lang.String getSourceTransaction()

setSourceTransaction

public void setSourceTransaction(java.lang.String sourceTransactionID)

getSourceTransactionObject

public Charge getSourceTransactionObject()

setSourceTransactionObject

public void setSourceTransactionObject(Charge sourceTransaction)

all

@Deprecated
public static TransferCollection all(java.util.Map<java.lang.String,java.lang.Object> params)
                                          throws AuthenticationException,
                                                 InvalidRequestException,
                                                 APIConnectionException,
                                                 CardException,
                                                 APIException

Deprecated. Use the list(Map) method instead. This method will be removed in the next major version.

List all transfers.

Throws:

AuthenticationException

InvalidRequestException

APIConnectionException

CardException

APIException

all

@Deprecated
public static TransferCollection all(java.util.Map<java.lang.String,java.lang.Object> params,
                                                 RequestOptions options)
                                          throws AuthenticationException,
                                                 InvalidRequestException,
                                                 APIConnectionException,
                                                 CardException,
                                                 APIException

Deprecated. Use the list(Map, RequestOptions) method instead. This method will be removed in the next major version.

List all transfers.

Throws:

AuthenticationException

InvalidRequestException

APIConnectionException

CardException

APIException

all

@Deprecated
public static TransferCollection all(java.util.Map<java.lang.String,java.lang.Object> params,
                                                 java.lang.String apiKey)
                                          throws AuthenticationException,
                                                 InvalidRequestException,
                                                 APIConnectionException,
                                                 CardException,
                                                 APIException

Deprecated. Use the list(Map, RequestOptions) method instead. This method will be removed in the next major version.

List all transfers.

Throws:

AuthenticationException

InvalidRequestException

APIConnectionException

CardException

APIException

cancel

@Deprecated
public Transfer cancel()
                            throws AuthenticationException,
                                   InvalidRequestException,
                                   APIConnectionException,
                                   CardException,
                                   APIException

Deprecated. Use the {#link Payout#cancel()} method instead.

Cancel a transfer.

Throws:

AuthenticationException

InvalidRequestException

APIConnectionException

CardException

APIException

cancel

@Deprecated
public Transfer cancel(RequestOptions options)
                            throws AuthenticationException,
                                   InvalidRequestException,
                                   APIConnectionException,
                                   CardException,
                                   APIException

Deprecated. Use the {#link Payout#cancel(RequestOptions)} method instead.

Cancel a transfer.

Throws:

AuthenticationException

InvalidRequestException

APIConnectionException

CardException

APIException

cancel

@Deprecated
public Transfer cancel(java.lang.String apiKey)
                            throws AuthenticationException,
                                   InvalidRequestException,
                                   APIConnectionException,
                                   CardException,
                                   APIException

Deprecated. Use the cancel(RequestOptions) method instead. This method will be removed in the next major version.

Cancel a transfer.

Throws:

AuthenticationException

InvalidRequestException

APIConnectionException

CardException

APIException

create

public static Transfer create(java.util.Map<java.lang.String,java.lang.Object> params)
                       throws AuthenticationException,
                              InvalidRequestException,
                              APIConnectionException,
                              CardException,
                              APIException

Create a transfer.

Throws:

AuthenticationException

InvalidRequestException

APIConnectionException

CardException

APIException

create

public static Transfer create(java.util.Map<java.lang.String,java.lang.Object> params,
                              RequestOptions options)
                       throws AuthenticationException,
                              InvalidRequestException,
                              APIConnectionException,
                              CardException,
                              APIException

Create a transfer.

Throws:

AuthenticationException

InvalidRequestException

APIConnectionException

CardException

APIException

create

@Deprecated
public static Transfer create(java.util.Map<java.lang.String,java.lang.Object> params,
                                          java.lang.String apiKey)
                                   throws AuthenticationException,
                                          InvalidRequestException,
                                          APIConnectionException,
                                          CardException,
                                          APIException

Deprecated. Use the create(Map, RequestOptions) method instead. This method will be removed in the next major version.

Create a transfer.

Throws:

AuthenticationException

InvalidRequestException

APIConnectionException

CardException

APIException

list

public static TransferCollection list(java.util.Map<java.lang.String,java.lang.Object> params)
                               throws AuthenticationException,
                                      InvalidRequestException,
                                      APIConnectionException,
                                      CardException,
                                      APIException

List all transfers.

Throws:

AuthenticationException

InvalidRequestException

APIConnectionException

CardException

APIException

list

public static TransferCollection list(java.util.Map<java.lang.String,java.lang.Object> params,
                                      RequestOptions options)
                               throws AuthenticationException,
                                      InvalidRequestException,
                                      APIConnectionException,
                                      CardException,
                                      APIException

List all transfers.

Throws:

AuthenticationException

InvalidRequestException

APIConnectionException

CardException

APIException

retrieve

public static Transfer retrieve(java.lang.String id)
                         throws AuthenticationException,
                                InvalidRequestException,
                                APIConnectionException,
                                CardException,
                                APIException

Retrive a transfer.

Throws:

AuthenticationException

InvalidRequestException

APIConnectionException

CardException

APIException

retrieve

public static Transfer retrieve(java.lang.String id,
                                RequestOptions options)
                         throws AuthenticationException,
                                InvalidRequestException,
                                APIConnectionException,
                                CardException,
                                APIException

Retrive a transfer.

Throws:

AuthenticationException

InvalidRequestException

APIConnectionException

CardException

APIException

retrieve

@Deprecated
public static Transfer retrieve(java.lang.String id,
                                            java.lang.String apiKey)
                                     throws AuthenticationException,
                                            InvalidRequestException,
                                            APIConnectionException,
                                            CardException,
                                            APIException

Deprecated. Use the retrieve(String, RequestOptions) method instead. This method will be removed in the next major version.

Retrive a transfer.

Throws:

AuthenticationException

InvalidRequestException

APIConnectionException

CardException

APIException

retrieve

public static Transfer retrieve(java.lang.String id,
                                java.util.Map<java.lang.String,java.lang.Object> params,
                                RequestOptions options)
                         throws AuthenticationException,
                                InvalidRequestException,
                                APIConnectionException,
                                CardException,
                                APIException

Retrive a transfer.

Throws:

AuthenticationException

InvalidRequestException

APIConnectionException

CardException

APIException

transactions

@Deprecated
public TransferTransactionCollection transactions(java.util.Map<java.lang.String,java.lang.Object> params)
                                                       throws AuthenticationException,
                                                              InvalidRequestException,
                                                              APIConnectionException,
                                                              CardException,
                                                              APIException

Deprecated. Prefer using the BalanceTransaction.list(Map) method with the payout parameter.

Retrieve a transfer's transactions.

Throws:

AuthenticationException

InvalidRequestException

APIConnectionException

CardException

APIException

transactions

@Deprecated
public TransferTransactionCollection transactions(java.util.Map<java.lang.String,java.lang.Object> params,
                                                              RequestOptions options)
                                                       throws AuthenticationException,
                                                              InvalidRequestException,
                                                              APIConnectionException,
                                                              CardException,
                                                              APIException

Deprecated. Prefer using the BalanceTransaction.list(Map, RequestOptions) method with the payout parameter.

Retrieve a transfer's transactions.

Throws:

AuthenticationException

InvalidRequestException

APIConnectionException

CardException

APIException

transactions

@Deprecated
public TransferTransactionCollection transactions(java.util.Map<java.lang.String,java.lang.Object> params,
                                                              java.lang.String apiKey)
                                                       throws AuthenticationException,
                                                              InvalidRequestException,
                                                              APIConnectionException,
                                                              CardException,
                                                              APIException

Deprecated. Use the transactions(Map, RequestOptions) method instead. This method will be removed in the next major version.

Retrieve a transfer's transactions.

Throws:

AuthenticationException

InvalidRequestException

APIConnectionException

CardException

APIException

update

public Transfer update(java.util.Map<java.lang.String,java.lang.Object> params)
                throws AuthenticationException,
                       InvalidRequestException,
                       APIConnectionException,
                       CardException,
                       APIException

Update a transfer.

Specified by:

update in interface MetadataStore<Transfer>

Throws:

AuthenticationException

InvalidRequestException

APIConnectionException

CardException

APIException

update

public Transfer update(java.util.Map<java.lang.String,java.lang.Object> params,
                       RequestOptions options)
                throws AuthenticationException,
                       InvalidRequestException,
                       APIConnectionException,
                       CardException,
                       APIException

Update a transfer.

Specified by:

update in interface MetadataStore<Transfer>

Throws:

AuthenticationException

InvalidRequestException

APIConnectionException

CardException

APIException

update

@Deprecated
public Transfer update(java.util.Map<java.lang.String,java.lang.Object> params,
                                   java.lang.String apiKey)
                            throws AuthenticationException,
                                   InvalidRequestException,
                                   APIConnectionException,
                                   CardException,
                                   APIException

Deprecated. Use the update(Map, RequestOptions) method instead. This method will be removed in the next major version.

Update a transfer.

Throws:

AuthenticationException

InvalidRequestException

APIConnectionException

CardException

APIException

getObject

public java.lang.String getObject()

getAmount

public java.lang.Long getAmount()

getAmountReversed

public java.lang.Long getAmountReversed()

getApplicationFee

public java.lang.String getApplicationFee()

getBankAccount

public BankAccount getBankAccount()

getCreated

public java.lang.Long getCreated()

getCurrency

public java.lang.String getCurrency()

getDate

public java.lang.Long getDate()

getDescription

public java.lang.String getDescription()

getFailureCode

public java.lang.String getFailureCode()

getFailureMessage

public java.lang.String getFailureMessage()

getLivemode

public java.lang.Boolean getLivemode()

getReversed

public java.lang.Boolean getReversed()

getSourceType

public java.lang.String getSourceType()

getStatementDescriptor

public java.lang.String getStatementDescriptor()

getStatus

public java.lang.String getStatus()

getTransferGroup

public java.lang.String getTransferGroup()

getType

public java.lang.String getType()

getAccount

@Deprecated
public BankAccount getAccount()

Deprecated. Prefer using the bankAccount attribute instead.

The account attribute.

Returns:

the account attribute

See Also:

API version 2014-05-19

getOtherTransfers

@Deprecated
public java.util.List<java.lang.String> getOtherTransfers()

Deprecated. Prefer using the BalanceTransaction.list(java.util.Map<java.lang.String, java.lang.Object>) method instead.

The other_transfers attribute.

Returns:

the other_transfers attribute

See Also:

API version 2014-08-04

getRecipient

@Deprecated
public java.lang.String getRecipient()

Deprecated.

getStatementDescription

@Deprecated
public java.lang.String getStatementDescription()

Deprecated. Prefer using the statementDescriptor attribute instead.

The statement_description attribute.

Returns:

the statement_description attribute

See Also:

API version 2014-12-17

getSummary

@Deprecated
public Summary getSummary()

Deprecated. Prefer using the BalanceTransaction.list(java.util.Map<java.lang.String, java.lang.Object>) method instead.

The summary attribute.

Returns:

the summary attribute

See Also:

API version 2014-08-04

setId

public void setId(java.lang.String id)

setObject

public void setObject(java.lang.String object)

setAmount

public void setAmount(java.lang.Long amount)

setAmountReversed

public void setAmountReversed(java.lang.Long amountReversed)

setApplicationFee

public void setApplicationFee(java.lang.String applicationFee)

setBankAccount

public void setBankAccount(BankAccount bankAccount)

setCreated

public void setCreated(java.lang.Long created)

setCurrency

public void setCurrency(java.lang.String currency)

setDate

public void setDate(java.lang.Long date)

setDescription

public void setDescription(java.lang.String description)

setFailureCode

public void setFailureCode(java.lang.String failureCode)

setFailureMessage

public void setFailureMessage(java.lang.String failureMessage)

setLivemode

public void setLivemode(java.lang.Boolean livemode)

setMetadata

public void setMetadata(java.util.Map<java.lang.String,java.lang.String> metadata)

setReversals

public void setReversals(TransferReversalCollection reversals)

setReversed

public void setReversed(java.lang.Boolean reversed)

setSourceType

public void setSourceType(java.lang.String sourceType)

setStatementDescriptor

public void setStatementDescriptor(java.lang.String statementDescriptor)

setStatus

public void setStatus(java.lang.String status)

setTransferGroup

public void setTransferGroup(java.lang.String transferGroup)

setType

public void setType(java.lang.String type)

setAccount

@Deprecated
public void setAccount(BankAccount account)

Deprecated. Prefer using the bankAccount attribute instead.

The account attribute.

See Also:

API version 2014-05-19

setOtherTransfers

@Deprecated
public void setOtherTransfers(java.util.List<java.lang.String> otherTransfers)

Deprecated. Prefer using the BalanceTransaction.list(java.util.Map<java.lang.String, java.lang.Object>) method instead.

The other_transfers attribute.

See Also:

API version 2014-08-04

setRecipient

@Deprecated
public void setRecipient(java.lang.String recipient)

Deprecated.

setStatementDescription

@Deprecated
public void setStatementDescription(java.lang.String statementDescription)

Deprecated. Prefer using the statementDescriptor attribute instead.

The statement_description attribute.

See Also:

API version 2014-12-17

setSummary

@Deprecated
public void setSummary(Summary summary)

Deprecated. Prefer using the BalanceTransaction.list(java.util.Map<java.lang.String, java.lang.Object>) method instead.

The summary attribute.

See Also:

API version 2014-08-04

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

canEqual

protected boolean canEqual(java.lang.Object other)

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

getId

public java.lang.String getId()

Specified by:

getId in interface HasId

getMetadata

public java.util.Map<java.lang.String,java.lang.String> getMetadata()

Specified by:

getMetadata in interface MetadataStore<Transfer>