Package model

Class BalanceTransfer

java.lang.Object

model.BalanceTransfer

@Generated("org.openapitools.codegen.languages.JavaClientCodegen")
public class BalanceTransfer
extends Object

A `balance_transfer` object.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	BalanceTransfer.CustomTypeAdapterFactory
static class	BalanceTransfer.StateEnum	The `state` of the `balance_transfer`.

Field Summary

Fields

Modifier and Type	Field	Description
static HashSet<String>	openapiFields
static HashSet<String>	openapiRequiredFields
static String	SERIALIZED_NAME_AMOUNT
static String	SERIALIZED_NAME_CREATED_AT
static String	SERIALIZED_NAME_CURRENCY
static String	SERIALIZED_NAME_DESCRIPTION
static String	SERIALIZED_NAME_DESTINATION
static String	SERIALIZED_NAME_EXTERNAL_REFERENCE_ID
static String	SERIALIZED_NAME_ID
static String	SERIALIZED_NAME_LINKS
static String	SERIALIZED_NAME_PROCESSOR_TYPE
static String	SERIALIZED_NAME_REFERENCE_ID
static String	SERIALIZED_NAME_SOURCE
static String	SERIALIZED_NAME_STATE
static String	SERIALIZED_NAME_TAGS
static String	SERIALIZED_NAME_UPDATED_AT

Constructor Summary

Constructors

Constructor	Description
BalanceTransfer()

Method Summary

Modifier and Type	Method	Description
BalanceTransfer	amount(Long amount)
BalanceTransfer	createdAt(OffsetDateTime createdAt)
BalanceTransfer	currency(Currency currency)
BalanceTransfer	description(String description)
BalanceTransfer	destination(String destination)
boolean	equals(Object o)
BalanceTransfer	externalReferenceId(String externalReferenceId)
static BalanceTransfer	fromJson(String jsonString)	Create an instance of BalanceTransfer given an JSON string
Long	getAmount()	The total amount that will be debited in cents (e.g.
OffsetDateTime	getCreatedAt()	Timestamp of when the object was created.
Currency	getCurrency()	Get currency
String	getDescription()	Additional information about the `balance_transfer` (e.g.
String	getDestination()	The account where funds get credited.
String	getExternalReferenceId()	ID generated by partner and returned to Finix.
String	getId()	ID of the `balance_transfer` resource.
ListLinks	getLinks()	Get links
String	getProcessorType()	Pass **LITLE_V1**; `balance_transfers` are only avalible for platforms with **LITLE_V1** credentials.
String	getReferenceId()	ID generated by Finix and sent to the partner.
String	getSource()	The account where funds get debited.
BalanceTransfer.StateEnum	getState()	The `state` of the `balance_transfer`.
Map<String,String>	getTags()	Key value pair for annotating custom meta data (e.g.
OffsetDateTime	getUpdatedAt()	Timestamp of when the object was last updated.
int	hashCode()
BalanceTransfer	id(String id)
BalanceTransfer	links(ListLinks links)
BalanceTransfer	processorType(String processorType)
BalanceTransfer	putTagsItem(String key, String tagsItem)
BalanceTransfer	referenceId(String referenceId)
void	setAmount(Long amount)
void	setCreatedAt(OffsetDateTime createdAt)
void	setCurrency(Currency currency)
void	setDescription(String description)
void	setDestination(String destination)
void	setExternalReferenceId(String externalReferenceId)
void	setId(String id)
void	setLinks(ListLinks links)
void	setProcessorType(String processorType)
void	setReferenceId(String referenceId)
void	setSource(String source)
void	setState(BalanceTransfer.StateEnum state)
void	setTags(Map<String,String> tags)
void	setUpdatedAt(OffsetDateTime updatedAt)
BalanceTransfer	source(String source)
BalanceTransfer	state(BalanceTransfer.StateEnum state)
BalanceTransfer	tags(Map<String,String> tags)
String	toJson()	Convert an instance of BalanceTransfer to an JSON string
String	toString()
BalanceTransfer	updatedAt(OffsetDateTime updatedAt)
static void	validateJsonObject(com.google.gson.JsonObject jsonObj)	Validates the JSON Object and throws an exception if issues found

Methods inherited from class java.lang.Object

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

Field Detail

SERIALIZED_NAME_ID

public static final String SERIALIZED_NAME_ID

See Also:

Constant Field Values

SERIALIZED_NAME_CREATED_AT

public static final String SERIALIZED_NAME_CREATED_AT

See Also:

Constant Field Values

SERIALIZED_NAME_UPDATED_AT

public static final String SERIALIZED_NAME_UPDATED_AT

See Also:

Constant Field Values

SERIALIZED_NAME_AMOUNT

public static final String SERIALIZED_NAME_AMOUNT

See Also:

Constant Field Values

SERIALIZED_NAME_CURRENCY

public static final String SERIALIZED_NAME_CURRENCY

See Also:

Constant Field Values

SERIALIZED_NAME_DESCRIPTION

public static final String SERIALIZED_NAME_DESCRIPTION

See Also:

Constant Field Values

SERIALIZED_NAME_DESTINATION

public static final String SERIALIZED_NAME_DESTINATION

See Also:

Constant Field Values

SERIALIZED_NAME_EXTERNAL_REFERENCE_ID

public static final String SERIALIZED_NAME_EXTERNAL_REFERENCE_ID

See Also:

Constant Field Values

SERIALIZED_NAME_PROCESSOR_TYPE

public static final String SERIALIZED_NAME_PROCESSOR_TYPE

See Also:

Constant Field Values

SERIALIZED_NAME_REFERENCE_ID

public static final String SERIALIZED_NAME_REFERENCE_ID

See Also:

Constant Field Values

SERIALIZED_NAME_SOURCE

public static final String SERIALIZED_NAME_SOURCE

See Also:

Constant Field Values

SERIALIZED_NAME_STATE

public static final String SERIALIZED_NAME_STATE

See Also:

Constant Field Values

SERIALIZED_NAME_TAGS

public static final String SERIALIZED_NAME_TAGS

See Also:

Constant Field Values

SERIALIZED_NAME_LINKS

public static final String SERIALIZED_NAME_LINKS

See Also:

Constant Field Values

openapiFields

public static HashSet<String> openapiFields

openapiRequiredFields

public static HashSet<String> openapiRequiredFields

Constructor Detail

BalanceTransfer

public BalanceTransfer()

Method Detail

id

public BalanceTransfer id(String id)

getId

@Nullable
public String getId()

ID of the `balance_transfer` resource.

Returns:

id

setId

public void setId(String id)

createdAt

public BalanceTransfer createdAt(OffsetDateTime createdAt)

getCreatedAt

@Nullable
public OffsetDateTime getCreatedAt()

Timestamp of when the object was created.

Returns:

createdAt

setCreatedAt

public void setCreatedAt(OffsetDateTime createdAt)

updatedAt

public BalanceTransfer updatedAt(OffsetDateTime updatedAt)

getUpdatedAt

@Nullable
public OffsetDateTime getUpdatedAt()

Timestamp of when the object was last updated.

Returns:

updatedAt

setUpdatedAt

public void setUpdatedAt(OffsetDateTime updatedAt)

amount

public BalanceTransfer amount(Long amount)

getAmount

@Nullable
public Long getAmount()

The total amount that will be debited in cents (e.g. 100 cents to debit $1.00).

Returns:

amount

setAmount

public void setAmount(Long amount)

currency

public BalanceTransfer currency(Currency currency)

getCurrency

@Nullable
public Currency getCurrency()

Get currency

Returns:

currency

setCurrency

public void setCurrency(Currency currency)

description

public BalanceTransfer description(String description)

getDescription

@Nullable
public String getDescription()

Additional information about the `balance_transfer` (e.g. **Transferring funds for Holidays**).

Returns:

description

setDescription

public void setDescription(String description)

destination

public BalanceTransfer destination(String destination)

getDestination

@Nullable
public String getDestination()

The account where funds get credited. For balance transfers, this is an aliased ID and will have the value of `FOR_BENEFIT_OF_ACCOUNT` or `OPERATING_ACCOUNT`.

Returns:

destination

setDestination

public void setDestination(String destination)

externalReferenceId

public BalanceTransfer externalReferenceId(String externalReferenceId)

getExternalReferenceId

@Nullable
public String getExternalReferenceId()

ID generated by partner and returned to Finix.

Returns:

externalReferenceId

setExternalReferenceId

public void setExternalReferenceId(String externalReferenceId)

processorType

public BalanceTransfer processorType(String processorType)

getProcessorType

@Nullable
public String getProcessorType()

Pass **LITLE_V1**; `balance_transfers` are only avalible for platforms with **LITLE_V1** credentials.

Returns:

processorType

setProcessorType

public void setProcessorType(String processorType)

referenceId

public BalanceTransfer referenceId(String referenceId)

getReferenceId

@Nullable
public String getReferenceId()

ID generated by Finix and sent to the partner.

Returns:

referenceId

setReferenceId

public void setReferenceId(String referenceId)

source

public BalanceTransfer source(String source)

getSource

@Nullable
public String getSource()

The account where funds get debited. For balance transfers, this is an aliased ID and will have the value of `FOR_BENEFIT_OF_ACCOUNT` or `OPERATING_ACCOUNT`.

Returns:

source

setSource

public void setSource(String source)

state

public BalanceTransfer state(BalanceTransfer.StateEnum state)

getState

@Nullable
public BalanceTransfer.StateEnum getState()

The `state` of the `balance_transfer`.

Returns:

state

setState

public void setState(BalanceTransfer.StateEnum state)

tags

public BalanceTransfer tags(Map<String,String> tags)

putTagsItem

public BalanceTransfer putTagsItem(String key,
                                   String tagsItem)

getTags

@Nullable
public Map<String,String> getTags()

Key value pair for annotating custom meta data (e.g. order numbers).

Returns:

tags

setTags

public void setTags(Map<String,String> tags)

links

public BalanceTransfer links(ListLinks links)

getLinks

@Nullable
public ListLinks getLinks()

Get links

Returns:

links

setLinks

public void setLinks(ListLinks links)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

validateJsonObject

public static void validateJsonObject(com.google.gson.JsonObject jsonObj)
                               throws IOException

Validates the JSON Object and throws an exception if issues found

Parameters:

jsonObj - JSON Object

Throws:

IOException - if the JSON Object is invalid with respect to BalanceTransfer

fromJson

public static BalanceTransfer fromJson(String jsonString)
                                throws IOException

Create an instance of BalanceTransfer given an JSON string

Parameters:

jsonString - JSON string

Returns:

An instance of BalanceTransfer

Throws:

IOException - if the JSON string is invalid with respect to BalanceTransfer

toJson

public String toJson()

Convert an instance of BalanceTransfer to an JSON string

Returns:

JSON string