Package com.stripe.model.treasury

Class InboundTransfer

java.lang.Object

com.stripe.model.StripeObject

com.stripe.net.ApiResource

com.stripe.model.treasury.InboundTransfer

All Implemented Interfaces:

HasId, StripeActiveObject, StripeObjectInterface

public class InboundTransfer
extends ApiResource
implements HasId

Legacy InboundTransfers are part of the v1 version of Treasury for platforms and do not support many of the features introduced in Treasury for platforms v2. Use Inbound Transfers instead of building a new v1 integration.

Use InboundTransfers to add funds to your FinancialAccount via a PaymentMethod that is owned by you. The funds will be transferred via an ACH debit.

Related guide: Moving money with Treasury using InboundTransfer objects

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	InboundTransfer.FailureDetails	For more details about FailureDetails, please refer to the API Reference.
static class	InboundTransfer.LinkedFlows	For more details about LinkedFlows, please refer to the API Reference.
static class	InboundTransfer.OriginPaymentMethodDetails	For more details about OriginPaymentMethodDetails, please refer to the API Reference.
static class	InboundTransfer.StatusTransitions	For more details about StatusTransitions, please refer to the API Reference.
static class	InboundTransfer.TestHelpers

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

ApiResource.RequestMethod

Field Summary

Fields inherited from class com.stripe.net.ApiResource

CHARSET, GSON, INTERNAL_GSON

Fields inherited from class com.stripe.model.StripeObject

PRETTY_PRINT_GSON

Constructor Summary

Constructors

Constructor	Description
InboundTransfer()

Method Summary

Modifier and Type	Method	Description
InboundTransfer	cancel()	Cancels an InboundTransfer.
InboundTransfer	cancel(RequestOptions options)	Cancels an InboundTransfer.
InboundTransfer	cancel(InboundTransferCancelParams params)	Cancels an InboundTransfer.
InboundTransfer	cancel(InboundTransferCancelParams params, RequestOptions options)	Cancels an InboundTransfer.
InboundTransfer	cancel(Map<String,Object> params)	Cancels an InboundTransfer.
InboundTransfer	cancel(Map<String,Object> params, RequestOptions options)	Cancels an InboundTransfer.
protected boolean	canEqual(Object other)
static InboundTransfer	create(InboundTransferCreateParams params)	Creates an InboundTransfer.
static InboundTransfer	create(InboundTransferCreateParams params, RequestOptions options)	Creates an InboundTransfer.
static InboundTransfer	create(Map<String,Object> params)	Creates an InboundTransfer.
static InboundTransfer	create(Map<String,Object> params, RequestOptions options)	Creates an InboundTransfer.
boolean	equals(Object o)
Long	getAmount()	Amount (in cents) transferred.
Boolean	getCancelable()	Returns true if the InboundTransfer is able to be canceled.
Long	getCreated()	Time at which the object was created.
String	getCurrency()	Three-letter ISO currency code, in lowercase.
String	getDescription()	An arbitrary string attached to the object.
InboundTransfer.FailureDetails	getFailureDetails()	Details about this InboundTransfer's failure.
String	getFinancialAccount()	The FinancialAccount that received the funds.
String	getHostedRegulatoryReceiptUrl()	A hosted transaction receipt URL that is provided when money movement is considered regulated under Stripe's money transmission licenses.
String	getId()	Unique identifier for the object.
InboundTransfer.LinkedFlows	getLinkedFlows()
Boolean	getLivemode()	If the object exists in live mode, the value is true.
Map<String,String>	getMetadata()	Set of key-value pairs that you can attach to an object.
String	getObject()	String representing the object's type.
String	getOriginPaymentMethod()	The origin payment method to be debited for an InboundTransfer.
InboundTransfer.OriginPaymentMethodDetails	getOriginPaymentMethodDetails()	Details about the PaymentMethod for an InboundTransfer.
Boolean	getReturned()	Returns true if the funds for an InboundTransfer were returned after the InboundTransfer went to the succeeded state.
String	getStatementDescriptor()	Statement descriptor shown when funds are debited from the source.
String	getStatus()	Status of the InboundTransfer: processing, succeeded, failed, and canceled.
InboundTransfer.StatusTransitions	getStatusTransitions()
InboundTransfer.TestHelpers	getTestHelpers()
String	getTransaction()	Get ID of expandable transaction object.
Transaction	getTransactionObject()	Get expanded transaction.
int	hashCode()
static InboundTransferCollection	list(InboundTransferListParams params)	Returns a list of InboundTransfers sent from the specified FinancialAccount.
static InboundTransferCollection	list(InboundTransferListParams params, RequestOptions options)	Returns a list of InboundTransfers sent from the specified FinancialAccount.
static InboundTransferCollection	list(Map<String,Object> params)	Returns a list of InboundTransfers sent from the specified FinancialAccount.
static InboundTransferCollection	list(Map<String,Object> params, RequestOptions options)	Returns a list of InboundTransfers sent from the specified FinancialAccount.
static InboundTransfer	retrieve(String id)	Retrieves the details of an existing InboundTransfer.
static InboundTransfer	retrieve(String id, RequestOptions options)	Retrieves the details of an existing InboundTransfer.
static InboundTransfer	retrieve(String id, InboundTransferRetrieveParams params, RequestOptions options)	Retrieves the details of an existing InboundTransfer.
static InboundTransfer	retrieve(String id, Map<String,Object> params, RequestOptions options)	Retrieves the details of an existing InboundTransfer.
void	setAmount(Long amount)	Amount (in cents) transferred.
void	setCancelable(Boolean cancelable)	Returns true if the InboundTransfer is able to be canceled.
void	setCreated(Long created)	Time at which the object was created.
void	setCurrency(String currency)	Three-letter ISO currency code, in lowercase.
void	setDescription(String description)	An arbitrary string attached to the object.
void	setFailureDetails(InboundTransfer.FailureDetails failureDetails)	Details about this InboundTransfer's failure.
void	setFinancialAccount(String financialAccount)	The FinancialAccount that received the funds.
void	setHostedRegulatoryReceiptUrl(String hostedRegulatoryReceiptUrl)	A hosted transaction receipt URL that is provided when money movement is considered regulated under Stripe's money transmission licenses.
void	setId(String id)	Unique identifier for the object.
void	setLinkedFlows(InboundTransfer.LinkedFlows linkedFlows)
void	setLivemode(Boolean livemode)	If the object exists in live mode, the value is true.
void	setMetadata(Map<String,String> metadata)	Set of key-value pairs that you can attach to an object.
void	setObject(String object)	String representing the object's type.
void	setOriginPaymentMethod(String originPaymentMethod)	The origin payment method to be debited for an InboundTransfer.
void	setOriginPaymentMethodDetails(InboundTransfer.OriginPaymentMethodDetails originPaymentMethodDetails)	Details about the PaymentMethod for an InboundTransfer.
void	setResponseGetter(StripeResponseGetter responseGetter)	Method is used by the containing object or StripeResponseGetter implementations to set the StripeResponseGetter instance used to make further requests.
void	setReturned(Boolean returned)	Returns true if the funds for an InboundTransfer were returned after the InboundTransfer went to the succeeded state.
void	setStatementDescriptor(String statementDescriptor)	Statement descriptor shown when funds are debited from the source.
void	setStatus(String status)	Status of the InboundTransfer: processing, succeeded, failed, and canceled.
void	setStatusTransitions(InboundTransfer.StatusTransitions statusTransitions)
void	setTransaction(String id)
void	setTransactionObject(Transaction expandableObject)

Methods inherited from class com.stripe.net.ApiResource

checkNullTypedParams, getGlobalResponseGetter, getResponseGetter, setExpandableFieldId, setGlobalResponseGetter, urlEncode, urlEncodeId

Methods inherited from class com.stripe.model.StripeObject

deserializeStripeObject, deserializeStripeObject, deserializeStripeObject, deserializeStripeObject, deserializeStripeObject, 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.StripeActiveObject

trySetResponseGetter

Constructor Details

InboundTransfer

public InboundTransfer()

Method Details

getTransaction

public String getTransaction()

Get ID of expandable transaction object.

setTransaction

public void setTransaction(String id)

getTransactionObject

public Transaction getTransactionObject()

Get expanded transaction.

setTransactionObject

public void setTransactionObject(Transaction expandableObject)

cancel

public InboundTransfer cancel()
                       throws StripeException

Cancels an InboundTransfer.

Throws:

StripeException

cancel

public InboundTransfer cancel(RequestOptions options)
                       throws StripeException

Cancels an InboundTransfer.

Throws:

StripeException

cancel

public InboundTransfer cancel(Map<String,Object> params)
                       throws StripeException

Cancels an InboundTransfer.

Throws:

StripeException

cancel

public InboundTransfer cancel(Map<String,Object> params,
 RequestOptions options)
                       throws StripeException

Cancels an InboundTransfer.

Throws:

StripeException

cancel

public InboundTransfer cancel(InboundTransferCancelParams params)
                       throws StripeException

Cancels an InboundTransfer.

Throws:

StripeException

cancel

public InboundTransfer cancel(InboundTransferCancelParams params,
 RequestOptions options)
                       throws StripeException

Cancels an InboundTransfer.

Throws:

StripeException

create

public static InboundTransfer create(Map<String,Object> params)
                              throws StripeException

Creates an InboundTransfer.

Throws:

StripeException

create

public static InboundTransfer create(Map<String,Object> params,
 RequestOptions options)
                              throws StripeException

Creates an InboundTransfer.

Throws:

StripeException

create

public static InboundTransfer create(InboundTransferCreateParams params)
                              throws StripeException

Creates an InboundTransfer.

Throws:

StripeException

create

public static InboundTransfer create(InboundTransferCreateParams params,
 RequestOptions options)
                              throws StripeException

Creates an InboundTransfer.

Throws:

StripeException

list

public static InboundTransferCollection list(Map<String,Object> params)
                                      throws StripeException

Returns a list of InboundTransfers sent from the specified FinancialAccount.

Throws:

StripeException

list

public static InboundTransferCollection list(Map<String,Object> params,
 RequestOptions options)
                                      throws StripeException

Returns a list of InboundTransfers sent from the specified FinancialAccount.

Throws:

StripeException

list

public static InboundTransferCollection list(InboundTransferListParams params)
                                      throws StripeException

Returns a list of InboundTransfers sent from the specified FinancialAccount.

Throws:

StripeException

list

public static InboundTransferCollection list(InboundTransferListParams params,
 RequestOptions options)
                                      throws StripeException

Returns a list of InboundTransfers sent from the specified FinancialAccount.

Throws:

StripeException

retrieve

public static InboundTransfer retrieve(String id)
                                throws StripeException

Retrieves the details of an existing InboundTransfer.

Throws:

StripeException

retrieve

public static InboundTransfer retrieve(String id,
 RequestOptions options)
                                throws StripeException

Retrieves the details of an existing InboundTransfer.

Throws:

StripeException

retrieve

public static InboundTransfer retrieve(String id,
 Map<String,Object> params,
 RequestOptions options)
                                throws StripeException

Retrieves the details of an existing InboundTransfer.

Throws:

StripeException

retrieve

public static InboundTransfer retrieve(String id,
 InboundTransferRetrieveParams params,
 RequestOptions options)
                                throws StripeException

Retrieves the details of an existing InboundTransfer.

Throws:

StripeException

getTestHelpers

public InboundTransfer.TestHelpers getTestHelpers()

setResponseGetter

public void setResponseGetter(StripeResponseGetter responseGetter)

Description copied from interface: StripeActiveObject

Method is used by the containing object or StripeResponseGetter implementations to set the StripeResponseGetter instance used to make further requests.

Specified by:

setResponseGetter in interface StripeActiveObject

Overrides:

setResponseGetter in class ApiResource

Parameters:

responseGetter - the StripeResponseGetter instance to use for making further requests.

getAmount

public Long getAmount()

Amount (in cents) transferred.

getCancelable

public Boolean getCancelable()

Returns true if the InboundTransfer is able to be canceled.

getCreated

public Long getCreated()

Time at which the object was created. Measured in seconds since the Unix epoch.

getCurrency

public String getCurrency()

Three-letter ISO currency code, in lowercase. Must be a supported currency.

getDescription

public String getDescription()

An arbitrary string attached to the object. Often useful for displaying to users.

getFailureDetails

public InboundTransfer.FailureDetails getFailureDetails()

Details about this InboundTransfer's failure. Will be set when status=failed or returned=true.

getFinancialAccount

public String getFinancialAccount()

The FinancialAccount that received the funds.

getHostedRegulatoryReceiptUrl

public String getHostedRegulatoryReceiptUrl()

A hosted transaction receipt URL that is provided when money movement is considered regulated under Stripe's money transmission licenses.

getLinkedFlows

public InboundTransfer.LinkedFlows getLinkedFlows()

getLivemode

public Boolean getLivemode()

If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.

getMetadata

public Map<String,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.

getObject

public String getObject()

String representing the object's type. Objects of the same type share the same value.

Equal to treasury.inbound_transfer.

getOriginPaymentMethod

public String getOriginPaymentMethod()

The origin payment method to be debited for an InboundTransfer.

getOriginPaymentMethodDetails

public InboundTransfer.OriginPaymentMethodDetails getOriginPaymentMethodDetails()

Details about the PaymentMethod for an InboundTransfer.

getReturned

public Boolean getReturned()

Returns true if the funds for an InboundTransfer were returned after the InboundTransfer went to the succeeded state.

getStatementDescriptor

public String getStatementDescriptor()

Statement descriptor shown when funds are debited from the source. Not all payment networks support statement_descriptor.

getStatus

public String getStatus()

Status of the InboundTransfer: processing, succeeded, failed, and canceled. An InboundTransfer is processing if it is created and pending. The status changes to succeeded once the funds have been "confirmed" and a transaction is created and posted. The status changes to failed if the transfer fails.

One of canceled, failed, processing, or succeeded.

getStatusTransitions

public InboundTransfer.StatusTransitions getStatusTransitions()

setAmount

public void setAmount(Long amount)

Amount (in cents) transferred.

setCancelable

public void setCancelable(Boolean cancelable)

Returns true if the InboundTransfer is able to be canceled.

setCreated

public void setCreated(Long created)

Time at which the object was created. Measured in seconds since the Unix epoch.

setCurrency

public void setCurrency(String currency)

Three-letter ISO currency code, in lowercase. Must be a supported currency.

setDescription

public void setDescription(String description)

An arbitrary string attached to the object. Often useful for displaying to users.

setFailureDetails

public void setFailureDetails(InboundTransfer.FailureDetails failureDetails)

Details about this InboundTransfer's failure. Will be set when status=failed or returned=true.

setFinancialAccount

public void setFinancialAccount(String financialAccount)

The FinancialAccount that received the funds.

setHostedRegulatoryReceiptUrl

public void setHostedRegulatoryReceiptUrl(String hostedRegulatoryReceiptUrl)

A hosted transaction receipt URL that is provided when money movement is considered regulated under Stripe's money transmission licenses.

setId

public void setId(String id)

Unique identifier for the object.

setLinkedFlows

public void setLinkedFlows(InboundTransfer.LinkedFlows linkedFlows)

setLivemode

public void setLivemode(Boolean livemode)

If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.

setMetadata

public void setMetadata(Map<String,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.

setObject

public void setObject(String object)

String representing the object's type. Objects of the same type share the same value.

Equal to treasury.inbound_transfer.

setOriginPaymentMethod

public void setOriginPaymentMethod(String originPaymentMethod)

The origin payment method to be debited for an InboundTransfer.

setOriginPaymentMethodDetails

public void setOriginPaymentMethodDetails(InboundTransfer.OriginPaymentMethodDetails originPaymentMethodDetails)

Details about the PaymentMethod for an InboundTransfer.

setReturned

public void setReturned(Boolean returned)

Returns true if the funds for an InboundTransfer were returned after the InboundTransfer went to the succeeded state.

setStatementDescriptor

public void setStatementDescriptor(String statementDescriptor)

Statement descriptor shown when funds are debited from the source. Not all payment networks support statement_descriptor.

setStatus

public void setStatus(String status)

Status of the InboundTransfer: processing, succeeded, failed, and canceled. An InboundTransfer is processing if it is created and pending. The status changes to succeeded once the funds have been "confirmed" and a transaction is created and posted. The status changes to failed if the transfer fails.

One of canceled, failed, processing, or succeeded.

setStatusTransitions

public void setStatusTransitions(InboundTransfer.StatusTransitions statusTransitions)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

canEqual

protected boolean canEqual(Object other)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getId

public String getId()

Unique identifier for the object.

Specified by:

getId in interface HasId