Package model

Class PaymentInstrument

java.lang.Object

model.PaymentInstrument

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

PaymentInstrument

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	PaymentInstrument.AccountTypeEnum	Details what kind of **BANK_ACCOUNT** is being used.
static enum	PaymentInstrument.AddressVerificationEnum	Additional address information that’s required to verify the identity of the merchant.
static enum	PaymentInstrument.BrandEnum	The `brand` of the card saved in the `Payment Instrument`.
static enum	PaymentInstrument.CardTypeEnum	The type of card saved in the `Payment Instrument`.
static class	PaymentInstrument.CustomTypeAdapterFactory
static enum	PaymentInstrument.InstrumentTypeEnum	The type of `Payment Instrument`.
static enum	PaymentInstrument.PayloadTypeEnum	Gets or Sets payloadType
static enum	PaymentInstrument.SecurityCodeVerificationEnum	Details the results of the Card Verification Code check.
static enum	PaymentInstrument.TypeEnum	Type of `Payment Instrument`.

Field Summary

Fields

Modifier and Type	Field	Description
static HashSet<String>	openapiFields
static HashSet<String>	openapiRequiredFields
static final String	SERIALIZED_NAME_ACCOUNT_TYPE
static final String	SERIALIZED_NAME_ADDRESS
static final String	SERIALIZED_NAME_ADDRESS_VERIFICATION
static final String	SERIALIZED_NAME_APPLICATION
static final String	SERIALIZED_NAME_BANK_CODE
static final String	SERIALIZED_NAME_BIN
static final String	SERIALIZED_NAME_BRAND
static final String	SERIALIZED_NAME_CARD_NAME
static final String	SERIALIZED_NAME_CARD_TYPE
static final String	SERIALIZED_NAME_COUNTRY
static final String	SERIALIZED_NAME_CREATED_AT
static final String	SERIALIZED_NAME_CURRENCY
static final String	SERIALIZED_NAME_EXPIRATION_MONTH
static final String	SERIALIZED_NAME_EXPIRATION_YEAR
static final String	SERIALIZED_NAME_FAST_FUNDS_INDICATOR
static final String	SERIALIZED_NAME_FINGERPRINT
static final String	SERIALIZED_NAME_ID
static final String	SERIALIZED_NAME_IDENTITY
static final String	SERIALIZED_NAME_INSTRUMENT_TYPE
static final String	SERIALIZED_NAME_LAST_FOUR
static final String	SERIALIZED_NAME_LINKS
static final String	SERIALIZED_NAME_MASKED_ACCOUNT_NUMBER
static final String	SERIALIZED_NAME_NAME
static final String	SERIALIZED_NAME_ONLINE_GAMBING_BLOCK_INDICATOR
static final String	SERIALIZED_NAME_PAYLOAD_TYPE
static final String	SERIALIZED_NAME_PUSH_FUNDS_BLOCK_INDICATOR
static final String	SERIALIZED_NAME_SECURITY_CODE_VERIFICATION
static final String	SERIALIZED_NAME_TAGS
static final String	SERIALIZED_NAME_TYPE
static final String	SERIALIZED_NAME_UPDATED_AT

Constructor Summary

Constructors

Constructor	Description
PaymentInstrument()

Method Summary

Modifier and Type	Method	Description
PaymentInstrument	accountType(PaymentInstrument.AccountTypeEnum accountType)
PaymentInstrument	address(Address address)
PaymentInstrument	addressVerification(PaymentInstrument.AddressVerificationEnum addressVerification)
PaymentInstrument	application(String application)
PaymentInstrument	bankCode(String bankCode)
PaymentInstrument	bin(String bin)
PaymentInstrument	brand(PaymentInstrument.BrandEnum brand)
PaymentInstrument	cardName(String cardName)
PaymentInstrument	cardType(PaymentInstrument.CardTypeEnum cardType)
PaymentInstrument	country(Country country)
PaymentInstrument	createdAt(OffsetDateTime createdAt)
PaymentInstrument	currency(Currency currency)
boolean	equals(Object o)
PaymentInstrument	expirationMonth(Long expirationMonth)
PaymentInstrument	expirationYear(Long expirationYear)
PaymentInstrument	fastFundsIndicator(String fastFundsIndicator)
PaymentInstrument	fingerprint(String fingerprint)
static PaymentInstrument	fromJson(String jsonString)	Create an instance of PaymentInstrument given an JSON string
PaymentInstrument.AccountTypeEnum	getAccountType()	Details what kind of **BANK_ACCOUNT** is being used.
Address	getAddress()	Get address
PaymentInstrument.AddressVerificationEnum	getAddressVerification()	Additional address information that’s required to verify the identity of the merchant.
String	getApplication()	The ID of the resource.
String	getBankCode()	The routing number of the bank account.
String	getBin()	Bank Identification number for the `Payment Instrument`.
PaymentInstrument.BrandEnum	getBrand()	The `brand` of the card saved in the `Payment Instrument`.
String	getCardName()	A custom name you can include to identify the card being used (e.g.
PaymentInstrument.CardTypeEnum	getCardType()	The type of card saved in the `Payment Instrument`.
Country	getCountry()	Get country
OffsetDateTime	getCreatedAt()	Timestamp of when the object was created.
Currency	getCurrency()	Get currency
Long	getExpirationMonth()	Expiration month (e.g.
Long	getExpirationYear()	4-digit expiration year.
String	getFastFundsIndicator()	Details if Fast Funds is enabled for the card.
String	getFingerprint()	Unique ID that represents the tokenized card data.
String	getId()	The ID of the resource.
String	getIdentity()	The ID of the resource.
PaymentInstrument.InstrumentTypeEnum	getInstrumentType()	The type of `Payment Instrument`.
String	getLastFour()	Last four digits of the card or bank account number.
PaymentInstrumentLinks	getLinks()	Get links
String	getMaskedAccountNumber()	The last 4 digits of the account number used to create the `Payment Instrument`.
String	getName()	The name of the bank account or card owner.
String	getOnlineGambingBlockIndicator()	Detailes if the card is enabled to receive push-payments for online gambling payouts.
PaymentInstrument.PayloadTypeEnum	getPayloadType()	Get payloadType
String	getPushFundsBlockIndicator()	Details if the card is enabled to receive push-to-card disbursements.
PaymentInstrument.SecurityCodeVerificationEnum	getSecurityCodeVerification()	Details the results of the Card Verification Code check.
Map<String,String>	getTags()	Key value pair for annotating custom meta data (e.g.
PaymentInstrument.TypeEnum	getType()	Type of `Payment Instrument`.
OffsetDateTime	getUpdatedAt()	Timestamp of when the object was last updated.
int	hashCode()
PaymentInstrument	id(String id)
PaymentInstrument	identity(String identity)
PaymentInstrument	instrumentType(PaymentInstrument.InstrumentTypeEnum instrumentType)
PaymentInstrument	lastFour(String lastFour)
PaymentInstrument	links(PaymentInstrumentLinks links)
PaymentInstrument	maskedAccountNumber(String maskedAccountNumber)
PaymentInstrument	name(String name)
PaymentInstrument	onlineGambingBlockIndicator(String onlineGambingBlockIndicator)
PaymentInstrument	payloadType(PaymentInstrument.PayloadTypeEnum payloadType)
PaymentInstrument	pushFundsBlockIndicator(String pushFundsBlockIndicator)
PaymentInstrument	putTagsItem(String key, String tagsItem)
PaymentInstrument	securityCodeVerification(PaymentInstrument.SecurityCodeVerificationEnum securityCodeVerification)
void	setAccountType(PaymentInstrument.AccountTypeEnum accountType)
void	setAddress(Address address)
void	setAddressVerification(PaymentInstrument.AddressVerificationEnum addressVerification)
void	setApplication(String application)
void	setBankCode(String bankCode)
void	setBin(String bin)
void	setBrand(PaymentInstrument.BrandEnum brand)
void	setCardName(String cardName)
void	setCardType(PaymentInstrument.CardTypeEnum cardType)
void	setCountry(Country country)
void	setCreatedAt(OffsetDateTime createdAt)
void	setCurrency(Currency currency)
void	setExpirationMonth(Long expirationMonth)
void	setExpirationYear(Long expirationYear)
void	setFastFundsIndicator(String fastFundsIndicator)
void	setFingerprint(String fingerprint)
void	setId(String id)
void	setIdentity(String identity)
void	setInstrumentType(PaymentInstrument.InstrumentTypeEnum instrumentType)
void	setLastFour(String lastFour)
void	setLinks(PaymentInstrumentLinks links)
void	setMaskedAccountNumber(String maskedAccountNumber)
void	setName(String name)
void	setOnlineGambingBlockIndicator(String onlineGambingBlockIndicator)
void	setPayloadType(PaymentInstrument.PayloadTypeEnum payloadType)
void	setPushFundsBlockIndicator(String pushFundsBlockIndicator)
void	setSecurityCodeVerification(PaymentInstrument.SecurityCodeVerificationEnum securityCodeVerification)
void	setTags(Map<String,String> tags)
void	setType(PaymentInstrument.TypeEnum type)
void	setUpdatedAt(OffsetDateTime updatedAt)
PaymentInstrument	tags(Map<String,String> tags)
String	toJson()	Convert an instance of PaymentInstrument to an JSON string
String	toString()
PaymentInstrument	type(PaymentInstrument.TypeEnum type)
PaymentInstrument	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 Details

SERIALIZED_NAME_TAGS

public static final String SERIALIZED_NAME_TAGS

See Also:

• Constant Field Values

SERIALIZED_NAME_TYPE

public static final String SERIALIZED_NAME_TYPE

See Also:

• Constant Field Values

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_ACCOUNT_TYPE

public static final String SERIALIZED_NAME_ACCOUNT_TYPE

See Also:

• Constant Field Values

SERIALIZED_NAME_APPLICATION

public static final String SERIALIZED_NAME_APPLICATION

See Also:

• Constant Field Values

SERIALIZED_NAME_BANK_CODE

public static final String SERIALIZED_NAME_BANK_CODE

See Also:

• Constant Field Values

SERIALIZED_NAME_COUNTRY

public static final String SERIALIZED_NAME_COUNTRY

See Also:

• Constant Field Values

SERIALIZED_NAME_CURRENCY

public static final String SERIALIZED_NAME_CURRENCY

See Also:

• Constant Field Values

SERIALIZED_NAME_FINGERPRINT

public static final String SERIALIZED_NAME_FINGERPRINT

See Also:

• Constant Field Values

SERIALIZED_NAME_IDENTITY

public static final String SERIALIZED_NAME_IDENTITY

See Also:

• Constant Field Values

SERIALIZED_NAME_INSTRUMENT_TYPE

public static final String SERIALIZED_NAME_INSTRUMENT_TYPE

See Also:

• Constant Field Values

SERIALIZED_NAME_MASKED_ACCOUNT_NUMBER

public static final String SERIALIZED_NAME_MASKED_ACCOUNT_NUMBER

See Also:

• Constant Field Values

SERIALIZED_NAME_NAME

public static final String SERIALIZED_NAME_NAME

See Also:

• Constant Field Values

SERIALIZED_NAME_PAYLOAD_TYPE

public static final String SERIALIZED_NAME_PAYLOAD_TYPE

See Also:

• Constant Field Values

SERIALIZED_NAME_LINKS

public static final String SERIALIZED_NAME_LINKS

See Also:

• Constant Field Values

SERIALIZED_NAME_ADDRESS

public static final String SERIALIZED_NAME_ADDRESS

See Also:

• Constant Field Values

SERIALIZED_NAME_ADDRESS_VERIFICATION

public static final String SERIALIZED_NAME_ADDRESS_VERIFICATION

See Also:

• Constant Field Values

SERIALIZED_NAME_BIN

public static final String SERIALIZED_NAME_BIN

See Also:

• Constant Field Values

SERIALIZED_NAME_BRAND

public static final String SERIALIZED_NAME_BRAND

See Also:

• Constant Field Values

SERIALIZED_NAME_CARD_NAME

public static final String SERIALIZED_NAME_CARD_NAME

See Also:

• Constant Field Values

SERIALIZED_NAME_CARD_TYPE

public static final String SERIALIZED_NAME_CARD_TYPE

See Also:

• Constant Field Values

SERIALIZED_NAME_EXPIRATION_MONTH

public static final String SERIALIZED_NAME_EXPIRATION_MONTH

See Also:

• Constant Field Values

SERIALIZED_NAME_EXPIRATION_YEAR

public static final String SERIALIZED_NAME_EXPIRATION_YEAR

See Also:

• Constant Field Values

SERIALIZED_NAME_FAST_FUNDS_INDICATOR

public static final String SERIALIZED_NAME_FAST_FUNDS_INDICATOR

See Also:

• Constant Field Values

SERIALIZED_NAME_LAST_FOUR

public static final String SERIALIZED_NAME_LAST_FOUR

See Also:

• Constant Field Values

SERIALIZED_NAME_ONLINE_GAMBING_BLOCK_INDICATOR

public static final String SERIALIZED_NAME_ONLINE_GAMBING_BLOCK_INDICATOR

See Also:

• Constant Field Values

SERIALIZED_NAME_PUSH_FUNDS_BLOCK_INDICATOR

public static final String SERIALIZED_NAME_PUSH_FUNDS_BLOCK_INDICATOR

See Also:

• Constant Field Values

SERIALIZED_NAME_SECURITY_CODE_VERIFICATION

public static final String SERIALIZED_NAME_SECURITY_CODE_VERIFICATION

See Also:

• Constant Field Values

openapiFields

public static HashSet<String> openapiFields

openapiRequiredFields

public static HashSet<String> openapiRequiredFields

Constructor Details

PaymentInstrument

public PaymentInstrument()

Method Details

tags

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

putTagsItem

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

type

public PaymentInstrument type(PaymentInstrument.TypeEnum type)

getType

@Nullable
public PaymentInstrument.TypeEnum getType()

Type of `Payment Instrument`.

Returns:

type

setType

public void setType(PaymentInstrument.TypeEnum type)

id

public PaymentInstrument id(String id)

getId

@Nullable
public String getId()

The ID of the resource.

Returns:

id

setId

public void setId(String id)

createdAt

public PaymentInstrument 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 PaymentInstrument updatedAt(OffsetDateTime updatedAt)

getUpdatedAt

@Nullable
public OffsetDateTime getUpdatedAt()

Timestamp of when the object was last updated.

Returns:

updatedAt

setUpdatedAt

public void setUpdatedAt(OffsetDateTime updatedAt)

accountType

public PaymentInstrument accountType(PaymentInstrument.AccountTypeEnum accountType)

getAccountType

@Nullable
public PaymentInstrument.AccountTypeEnum getAccountType()

Details what kind of **BANK_ACCOUNT** is being used.

Returns:

accountType

setAccountType

public void setAccountType(PaymentInstrument.AccountTypeEnum accountType)

application

public PaymentInstrument application(String application)

getApplication

@Nullable
public String getApplication()

The ID of the resource.

Returns:

application

setApplication

public void setApplication(String application)

bankCode

public PaymentInstrument bankCode(String bankCode)

getBankCode

@Nullable
public String getBankCode()

The routing number of the bank account.

Returns:

bankCode

setBankCode

public void setBankCode(String bankCode)

country

public PaymentInstrument country(Country country)

getCountry

@Nullable
public Country getCountry()

Get country

Returns:

country

setCountry

public void setCountry(Country country)

currency

public PaymentInstrument currency(Currency currency)

getCurrency

@Nullable
public Currency getCurrency()

Get currency

Returns:

currency

setCurrency

public void setCurrency(Currency currency)

fingerprint

public PaymentInstrument fingerprint(String fingerprint)

getFingerprint

@Nullable
public String getFingerprint()

Unique ID that represents the tokenized card data.

Returns:

fingerprint

setFingerprint

public void setFingerprint(String fingerprint)

identity

public PaymentInstrument identity(String identity)

getIdentity

@Nullable
public String getIdentity()

The ID of the resource.

Returns:

identity

setIdentity

public void setIdentity(String identity)

instrumentType

public PaymentInstrument instrumentType(PaymentInstrument.InstrumentTypeEnum instrumentType)

getInstrumentType

@Nullable
public PaymentInstrument.InstrumentTypeEnum getInstrumentType()

The type of `Payment Instrument`.

Returns:

instrumentType

setInstrumentType

public void setInstrumentType(PaymentInstrument.InstrumentTypeEnum instrumentType)

maskedAccountNumber

public PaymentInstrument maskedAccountNumber(String maskedAccountNumber)

getMaskedAccountNumber

@Nullable
public String getMaskedAccountNumber()

The last 4 digits of the account number used to create the `Payment Instrument`.

Returns:

maskedAccountNumber

setMaskedAccountNumber

public void setMaskedAccountNumber(String maskedAccountNumber)

name

public PaymentInstrument name(String name)

getName

@Nullable
public String getName()

The name of the bank account or card owner.

Returns:

name

setName

public void setName(String name)

payloadType

public PaymentInstrument payloadType(PaymentInstrument.PayloadTypeEnum payloadType)

getPayloadType

@Nullable
public PaymentInstrument.PayloadTypeEnum getPayloadType()

Get payloadType

Returns:

payloadType

setPayloadType

public void setPayloadType(PaymentInstrument.PayloadTypeEnum payloadType)

links

public PaymentInstrument links(PaymentInstrumentLinks links)

getLinks

@Nullable
public PaymentInstrumentLinks getLinks()

Get links

Returns:

links

setLinks

public void setLinks(PaymentInstrumentLinks links)

address

public PaymentInstrument address(Address address)

getAddress

@Nullable
public Address getAddress()

Get address

Returns:

address

setAddress

public void setAddress(Address address)

addressVerification

public PaymentInstrument addressVerification(PaymentInstrument.AddressVerificationEnum addressVerification)

getAddressVerification

@Nullable
public PaymentInstrument.AddressVerificationEnum getAddressVerification()

Additional address information that’s required to verify the identity of the merchant.

Returns:

addressVerification

setAddressVerification

public void setAddressVerification(PaymentInstrument.AddressVerificationEnum addressVerification)

bin

public PaymentInstrument bin(String bin)

getBin

@Nullable
public String getBin()

Bank Identification number for the `Payment Instrument`.

Returns:

bin

setBin

public void setBin(String bin)

brand

public PaymentInstrument brand(PaymentInstrument.BrandEnum brand)

getBrand

@Nullable
public PaymentInstrument.BrandEnum getBrand()

The `brand` of the card saved in the `Payment Instrument`.

Returns:

brand

setBrand

public void setBrand(PaymentInstrument.BrandEnum brand)

cardName

public PaymentInstrument cardName(String cardName)

getCardName

@Nullable
public String getCardName()

A custom name you can include to identify the card being used (e.g. **Business Card**).

Returns:

cardName

setCardName

public void setCardName(String cardName)

cardType

public PaymentInstrument cardType(PaymentInstrument.CardTypeEnum cardType)

getCardType

@Nullable
public PaymentInstrument.CardTypeEnum getCardType()

The type of card saved in the `Payment Instrument`.

Returns:

cardType

setCardType

public void setCardType(PaymentInstrument.CardTypeEnum cardType)

expirationMonth

public PaymentInstrument expirationMonth(Long expirationMonth)

getExpirationMonth

@Nullable
public Long getExpirationMonth()

Expiration month (e.g. 12 for December). minimum: 1 maximum: 12

Returns:

expirationMonth

setExpirationMonth

public void setExpirationMonth(Long expirationMonth)

expirationYear

public PaymentInstrument expirationYear(Long expirationYear)

getExpirationYear

@Nullable
public Long getExpirationYear()

4-digit expiration year. minimum: 1

Returns:

expirationYear

setExpirationYear

public void setExpirationYear(Long expirationYear)

fastFundsIndicator

public PaymentInstrument fastFundsIndicator(String fastFundsIndicator)

getFastFundsIndicator

@Nullable
public String getFastFundsIndicator()

Details if Fast Funds is enabled for the card.

Returns:

fastFundsIndicator

setFastFundsIndicator

public void setFastFundsIndicator(String fastFundsIndicator)

lastFour

public PaymentInstrument lastFour(String lastFour)

getLastFour

@Nullable
public String getLastFour()

Last four digits of the card or bank account number.

Returns:

lastFour

setLastFour

public void setLastFour(String lastFour)

onlineGambingBlockIndicator

public PaymentInstrument onlineGambingBlockIndicator(String onlineGambingBlockIndicator)

getOnlineGambingBlockIndicator

@Nullable
public String getOnlineGambingBlockIndicator()

Detailes if the card is enabled to receive push-payments for online gambling payouts.

Returns:

onlineGambingBlockIndicator

setOnlineGambingBlockIndicator

public void setOnlineGambingBlockIndicator(String onlineGambingBlockIndicator)

pushFundsBlockIndicator

public PaymentInstrument pushFundsBlockIndicator(String pushFundsBlockIndicator)

getPushFundsBlockIndicator

@Nullable
public String getPushFundsBlockIndicator()

Details if the card is enabled to receive push-to-card disbursements.

Returns:

pushFundsBlockIndicator

setPushFundsBlockIndicator

public void setPushFundsBlockIndicator(String pushFundsBlockIndicator)

securityCodeVerification

public PaymentInstrument securityCodeVerification(PaymentInstrument.SecurityCodeVerificationEnum securityCodeVerification)

getSecurityCodeVerification

@Nullable
public PaymentInstrument.SecurityCodeVerificationEnum getSecurityCodeVerification()

Details the results of the Card Verification Code check.

Returns:

securityCodeVerification

setSecurityCodeVerification

public void setSecurityCodeVerification(PaymentInstrument.SecurityCodeVerificationEnum securityCodeVerification)

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 PaymentInstrument

fromJson

public static PaymentInstrument fromJson(String jsonString)
                                  throws IOException

Create an instance of PaymentInstrument given an JSON string

Parameters:

jsonString - JSON string

Returns:

An instance of PaymentInstrument

Throws:

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

toJson

public String toJson()

Convert an instance of PaymentInstrument to an JSON string

Returns:

JSON string