Package model

Class CreateTransferRequest

java.lang.Object

model.CreateTransferRequest

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2022-06-24T13:03:18.088665-07:00[America/Los_Angeles]")
public class CreateTransferRequest
extends Object

Create a `transfer`.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CreateTransferRequest.CustomTypeAdapterFactory
static enum	CreateTransferRequest.GatewayEnum	Name of the gateway that processed this `transfer`.
static enum	CreateTransferRequest.InputMethodEnum	Details how the card details were entered.
static enum	CreateTransferRequest.OperationKeyEnum	Details the operation that'll be performed in the transaction.

Field Summary

Fields

Modifier and Type	Field	Description
static HashSet<String>	openapiFields
static HashSet<String>	openapiRequiredFields
static final String	SERIALIZED_NAME_3D_SECURE_AUTHENTICATION
static final String	SERIALIZED_NAME_ADDITIONAL_PURCHASE_DATA
static final String	SERIALIZED_NAME_ADJUSTMENT_REQUEST
static final String	SERIALIZED_NAME_AMOUNT
static final String	SERIALIZED_NAME_CONFIG_OVERRIDE
static final String	SERIALIZED_NAME_CURRENCY
static final String	SERIALIZED_NAME_DESTINATION
static final String	SERIALIZED_NAME_DEVICE
static final String	SERIALIZED_NAME_DEVICE_CONFIGURATION
static final String	SERIALIZED_NAME_FEE
static final String	SERIALIZED_NAME_GATEWAY
static final String	SERIALIZED_NAME_IDEMPOTENCY_ID
static final String	SERIALIZED_NAME_INPUT_METHOD
static final String	SERIALIZED_NAME_MERCHANT
static final String	SERIALIZED_NAME_MERCHANT_IDENTITY
static final String	SERIALIZED_NAME_OPERATION_KEY
static final String	SERIALIZED_NAME_PAYMENT_INSTRUMENT
static final String	SERIALIZED_NAME_PROCESSOR
static final String	SERIALIZED_NAME_SOURCE
static final String	SERIALIZED_NAME_STATEMENT_DESCRIPTOR
static final String	SERIALIZED_NAME_TAGS

Constructor Summary

Constructors

Constructor	Description
CreateTransferRequest()

Method Summary

Modifier and Type	Method	Description
CreateTransferRequest	_3dSecureAuthentication(CreateAuthorizationRequest3dSecureAuthentication _3dSecureAuthentication)
CreateTransferRequest	additionalPurchaseData(AdditionalPurchaseData additionalPurchaseData)
CreateTransferRequest	adjustmentRequest(Boolean adjustmentRequest)
CreateTransferRequest	amount(Long amount)
CreateTransferRequest	configOverride(Map<String,String> configOverride)
CreateTransferRequest	currency(Currency currency)
CreateTransferRequest	destination(String destination)
CreateTransferRequest	device(String device)
CreateTransferRequest	deviceConfiguration(ConfigurationDetails deviceConfiguration)
boolean	equals(Object o)
CreateTransferRequest	fee(Long fee)
static CreateTransferRequest	fromJson(String jsonString)	Create an instance of CreateTransferRequest given an JSON string
CreateTransferRequest	gateway(CreateTransferRequest.GatewayEnum gateway)
CreateAuthorizationRequest3dSecureAuthentication	get3dSecureAuthentication()	Get _3dSecureAuthentication
AdditionalPurchaseData	getAdditionalPurchaseData()	Get additionalPurchaseData
Boolean	getAdjustmentRequest()	Details if the `transfer` was created to adjust funds.
Long	getAmount()	The total amount that will be debited in cents (e.g.
Map<String,String>	getConfigOverride()	Get configOverride
Currency	getCurrency()	Get currency
String	getDestination()	ID of the `Payment Instrument` where funds will be sent.
String	getDevice()	The ID of the activated device.
ConfigurationDetails	getDeviceConfiguration()	Get deviceConfiguration
Long	getFee()	The amount of the `Transfer` you'd like to collect as your fee in cents.
CreateTransferRequest.GatewayEnum	getGateway()	Name of the gateway that processed this `transfer`.
String	getIdempotencyId()	A randomly generated value that'll be associated with the request.
CreateTransferRequest.InputMethodEnum	getInputMethod()	Details how the card details were entered.
String	getMerchant()	ID of the `Merchant` the `Transfer` was created under.
String	getMerchantIdentity()	ID of the `Identity` the `Merchant` was created under and the `Transfer` was submitted with.
CreateTransferRequest.OperationKeyEnum	getOperationKey()	Details the operation that'll be performed in the transaction.
CardPresentInstrumentForm	getPaymentInstrument()	Get paymentInstrument
String	getProcessor()	Name of the transaction processor.
String	getSource()	ID of the `Payment Instrument` where funds get debited.
String	getStatementDescriptor()	The description of the transaction that appears on the buyer's bank or card statement.
Map<String,String>	getTags()	Key value pair for annotating custom meta data (e.g.
int	hashCode()
CreateTransferRequest	idempotencyId(String idempotencyId)
CreateTransferRequest	inputMethod(CreateTransferRequest.InputMethodEnum inputMethod)
CreateTransferRequest	merchant(String merchant)
CreateTransferRequest	merchantIdentity(String merchantIdentity)
CreateTransferRequest	operationKey(CreateTransferRequest.OperationKeyEnum operationKey)
CreateTransferRequest	paymentInstrument(CardPresentInstrumentForm paymentInstrument)
CreateTransferRequest	processor(String processor)
CreateTransferRequest	putConfigOverrideItem(String key, String configOverrideItem)
CreateTransferRequest	putTagsItem(String key, String tagsItem)
void	set3dSecureAuthentication(CreateAuthorizationRequest3dSecureAuthentication _3dSecureAuthentication)
void	setAdditionalPurchaseData(AdditionalPurchaseData additionalPurchaseData)
void	setAdjustmentRequest(Boolean adjustmentRequest)
void	setAmount(Long amount)
void	setConfigOverride(Map<String,String> configOverride)
void	setCurrency(Currency currency)
void	setDestination(String destination)
void	setDevice(String device)
void	setDeviceConfiguration(ConfigurationDetails deviceConfiguration)
void	setFee(Long fee)
void	setGateway(CreateTransferRequest.GatewayEnum gateway)
void	setIdempotencyId(String idempotencyId)
void	setInputMethod(CreateTransferRequest.InputMethodEnum inputMethod)
void	setMerchant(String merchant)
void	setMerchantIdentity(String merchantIdentity)
void	setOperationKey(CreateTransferRequest.OperationKeyEnum operationKey)
void	setPaymentInstrument(CardPresentInstrumentForm paymentInstrument)
void	setProcessor(String processor)
void	setSource(String source)
void	setStatementDescriptor(String statementDescriptor)
void	setTags(Map<String,String> tags)
CreateTransferRequest	source(String source)
CreateTransferRequest	statementDescriptor(String statementDescriptor)
CreateTransferRequest	tags(Map<String,String> tags)
String	toJson()	Convert an instance of CreateTransferRequest to an JSON string
String	toString()
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 Details

SERIALIZED_NAME_TAGS

public static final String SERIALIZED_NAME_TAGS

See Also:

• Constant Field Values

SERIALIZED_NAME_ADJUSTMENT_REQUEST

public static final String SERIALIZED_NAME_ADJUSTMENT_REQUEST

See Also:

• Constant Field Values

SERIALIZED_NAME_AMOUNT

public static final String SERIALIZED_NAME_AMOUNT

See Also:

• Constant Field Values

SERIALIZED_NAME_CONFIG_OVERRIDE

public static final String SERIALIZED_NAME_CONFIG_OVERRIDE

See Also:

• Constant Field Values

SERIALIZED_NAME_CURRENCY

public static final String SERIALIZED_NAME_CURRENCY

See Also:

• Constant Field Values

SERIALIZED_NAME_DESTINATION

public static final String SERIALIZED_NAME_DESTINATION

See Also:

• Constant Field Values

SERIALIZED_NAME_DEVICE

public static final String SERIALIZED_NAME_DEVICE

See Also:

• Constant Field Values

SERIALIZED_NAME_DEVICE_CONFIGURATION

public static final String SERIALIZED_NAME_DEVICE_CONFIGURATION

See Also:

• Constant Field Values

SERIALIZED_NAME_FEE

public static final String SERIALIZED_NAME_FEE

See Also:

• Constant Field Values

SERIALIZED_NAME_GATEWAY

public static final String SERIALIZED_NAME_GATEWAY

See Also:

• Constant Field Values

SERIALIZED_NAME_3D_SECURE_AUTHENTICATION

public static final String SERIALIZED_NAME_3D_SECURE_AUTHENTICATION

See Also:

• Constant Field Values

SERIALIZED_NAME_IDEMPOTENCY_ID

public static final String SERIALIZED_NAME_IDEMPOTENCY_ID

See Also:

• Constant Field Values

SERIALIZED_NAME_INPUT_METHOD

public static final String SERIALIZED_NAME_INPUT_METHOD

See Also:

• Constant Field Values

SERIALIZED_NAME_MERCHANT

public static final String SERIALIZED_NAME_MERCHANT

See Also:

• Constant Field Values

SERIALIZED_NAME_MERCHANT_IDENTITY

public static final String SERIALIZED_NAME_MERCHANT_IDENTITY

See Also:

• Constant Field Values

SERIALIZED_NAME_OPERATION_KEY

public static final String SERIALIZED_NAME_OPERATION_KEY

See Also:

• Constant Field Values

SERIALIZED_NAME_PAYMENT_INSTRUMENT

public static final String SERIALIZED_NAME_PAYMENT_INSTRUMENT

See Also:

• Constant Field Values

SERIALIZED_NAME_PROCESSOR

public static final String SERIALIZED_NAME_PROCESSOR

See Also:

• Constant Field Values

SERIALIZED_NAME_SOURCE

public static final String SERIALIZED_NAME_SOURCE

See Also:

• Constant Field Values

SERIALIZED_NAME_STATEMENT_DESCRIPTOR

public static final String SERIALIZED_NAME_STATEMENT_DESCRIPTOR

See Also:

• Constant Field Values

SERIALIZED_NAME_ADDITIONAL_PURCHASE_DATA

public static final String SERIALIZED_NAME_ADDITIONAL_PURCHASE_DATA

See Also:

• Constant Field Values

openapiFields

public static HashSet<String> openapiFields

openapiRequiredFields

public static HashSet<String> openapiRequiredFields

Constructor Details

CreateTransferRequest

public CreateTransferRequest()

Method Details

tags

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

putTagsItem

public CreateTransferRequest 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)

adjustmentRequest

public CreateTransferRequest adjustmentRequest(Boolean adjustmentRequest)

getAdjustmentRequest

@Nullable
public Boolean getAdjustmentRequest()

Details if the `transfer` was created to adjust funds.

Returns:

adjustmentRequest

setAdjustmentRequest

public void setAdjustmentRequest(Boolean adjustmentRequest)

amount

public CreateTransferRequest 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)

configOverride

public CreateTransferRequest configOverride(Map<String,String> configOverride)

putConfigOverrideItem

public CreateTransferRequest putConfigOverrideItem(String key,
 String configOverrideItem)

getConfigOverride

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

Get configOverride

Returns:

configOverride

setConfigOverride

public void setConfigOverride(Map<String,String> configOverride)

currency

public CreateTransferRequest currency(Currency currency)

getCurrency

@Nullable
public Currency getCurrency()

Get currency

Returns:

currency

setCurrency

public void setCurrency(Currency currency)

destination

public CreateTransferRequest destination(String destination)

getDestination

@Nullable
public String getDestination()

ID of the `Payment Instrument` where funds will be sent.

Returns:

destination

setDestination

public void setDestination(String destination)

device

public CreateTransferRequest device(String device)

getDevice

@Nullable
public String getDevice()

The ID of the activated device.

Returns:

device

setDevice

public void setDevice(String device)

deviceConfiguration

public CreateTransferRequest deviceConfiguration(ConfigurationDetails deviceConfiguration)

getDeviceConfiguration

@Nullable
public ConfigurationDetails getDeviceConfiguration()

Get deviceConfiguration

Returns:

deviceConfiguration

setDeviceConfiguration

public void setDeviceConfiguration(ConfigurationDetails deviceConfiguration)

fee

public CreateTransferRequest fee(Long fee)

getFee

@Nullable
public Long getFee()

The amount of the `Transfer` you'd like to collect as your fee in cents. Defaults to zero (must be less than or equal to the `amount`).

Returns:

fee

setFee

public void setFee(Long fee)

gateway

public CreateTransferRequest gateway(CreateTransferRequest.GatewayEnum gateway)

getGateway

@Nullable
public CreateTransferRequest.GatewayEnum getGateway()

Name of the gateway that processed this `transfer`. (Finix Core only).

Returns:

gateway

setGateway

public void setGateway(CreateTransferRequest.GatewayEnum gateway)

_3dSecureAuthentication

public CreateTransferRequest _3dSecureAuthentication(CreateAuthorizationRequest3dSecureAuthentication _3dSecureAuthentication)

get3dSecureAuthentication

@Nullable
public CreateAuthorizationRequest3dSecureAuthentication get3dSecureAuthentication()

Get _3dSecureAuthentication

Returns:

_3dSecureAuthentication

set3dSecureAuthentication

public void set3dSecureAuthentication(CreateAuthorizationRequest3dSecureAuthentication _3dSecureAuthentication)

idempotencyId

public CreateTransferRequest idempotencyId(String idempotencyId)

getIdempotencyId

@Nullable
public String getIdempotencyId()

A randomly generated value that'll be associated with the request.

Returns:

idempotencyId

setIdempotencyId

public void setIdempotencyId(String idempotencyId)

inputMethod

public CreateTransferRequest inputMethod(CreateTransferRequest.InputMethodEnum inputMethod)

getInputMethod

@Nullable
public CreateTransferRequest.InputMethodEnum getInputMethod()

Details how the card details were entered.

Returns:

inputMethod

setInputMethod

public void setInputMethod(CreateTransferRequest.InputMethodEnum inputMethod)

merchant

public CreateTransferRequest merchant(String merchant)

getMerchant

@Nullable
public String getMerchant()

ID of the `Merchant` the `Transfer` was created under.

Returns:

merchant

setMerchant

public void setMerchant(String merchant)

merchantIdentity

public CreateTransferRequest merchantIdentity(String merchantIdentity)

getMerchantIdentity

@Nullable
public String getMerchantIdentity()

ID of the `Identity` the `Merchant` was created under and the `Transfer` was submitted with.

Returns:

merchantIdentity

setMerchantIdentity

public void setMerchantIdentity(String merchantIdentity)

operationKey

public CreateTransferRequest operationKey(CreateTransferRequest.OperationKeyEnum operationKey)

getOperationKey

@Nullable
public CreateTransferRequest.OperationKeyEnum getOperationKey()

Details the operation that'll be performed in the transaction.

Returns:

operationKey

setOperationKey

public void setOperationKey(CreateTransferRequest.OperationKeyEnum operationKey)

paymentInstrument

public CreateTransferRequest paymentInstrument(CardPresentInstrumentForm paymentInstrument)

getPaymentInstrument

@Nullable
public CardPresentInstrumentForm getPaymentInstrument()

Get paymentInstrument

Returns:

paymentInstrument

setPaymentInstrument

public void setPaymentInstrument(CardPresentInstrumentForm paymentInstrument)

processor

public CreateTransferRequest processor(String processor)

getProcessor

@Nullable
public String getProcessor()

Name of the transaction processor.

Returns:

processor

setProcessor

public void setProcessor(String processor)

source

public CreateTransferRequest source(String source)

getSource

@Nullable
public String getSource()

ID of the `Payment Instrument` where funds get debited.

Returns:

source

setSource

public void setSource(String source)

statementDescriptor

public CreateTransferRequest statementDescriptor(String statementDescriptor)

getStatementDescriptor

@Nullable
public String getStatementDescriptor()

The description of the transaction that appears on the buyer's bank or card statement.

Returns:

statementDescriptor

setStatementDescriptor

public void setStatementDescriptor(String statementDescriptor)

additionalPurchaseData

public CreateTransferRequest additionalPurchaseData(AdditionalPurchaseData additionalPurchaseData)

getAdditionalPurchaseData

@Nullable
public AdditionalPurchaseData getAdditionalPurchaseData()

Get additionalPurchaseData

Returns:

additionalPurchaseData

setAdditionalPurchaseData

public void setAdditionalPurchaseData(AdditionalPurchaseData additionalPurchaseData)

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 CreateTransferRequest

fromJson

public static CreateTransferRequest fromJson(String jsonString)
                                      throws IOException

Create an instance of CreateTransferRequest given an JSON string

Parameters:

jsonString - JSON string

Returns:

An instance of CreateTransferRequest

Throws:

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

toJson

public String toJson()

Convert an instance of CreateTransferRequest to an JSON string

Returns:

JSON string