Package model
Class PaymentInstrument
- java.lang.Object
-
- model.PaymentInstrument
-
@Generated("org.openapitools.codegen.languages.JavaClientCodegen") public class PaymentInstrument extends Object
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classPaymentInstrument.AccountTypeEnumDetails what kind of **BANK_ACCOUNT** is being used.static classPaymentInstrument.AddressVerificationEnumAdditional address information that’s required to verify the identity of the merchant.static classPaymentInstrument.BankAccountValidationCheckEnumDetails the results of the bank account validation check if `attempt_bank_account_validation_check` is set to **true**.static classPaymentInstrument.CustomTypeAdapterFactorystatic classPaymentInstrument.InstrumentTypeEnumThe type of `Payment Instrument`.static classPaymentInstrument.PayloadTypeEnumGets or Sets payloadTypestatic classPaymentInstrument.SecurityCodeVerificationEnumDetails the results of the Card Verification Code check.static classPaymentInstrument.TypeEnumType of `Payment Instrument`.
-
Field Summary
-
Constructor Summary
Constructors Constructor Description PaymentInstrument()
-
Method Summary
-
-
-
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_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_APPLICATION
public static final String SERIALIZED_NAME_APPLICATION
- 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_CURRENCY
public static final String SERIALIZED_NAME_CURRENCY
- 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_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_LAST_FOUR
public static final String SERIALIZED_NAME_LAST_FOUR
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_NAME
public static final String SERIALIZED_NAME_NAME
- 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_PAYLOAD_TYPE
public static final String SERIALIZED_NAME_PAYLOAD_TYPE
- 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
-
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_LINKS
public static final String SERIALIZED_NAME_LINKS
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_ACCOUNT_TYPE
public static final String SERIALIZED_NAME_ACCOUNT_TYPE
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_BANK_ACCOUNT_VALIDATION_CHECK
public static final String SERIALIZED_NAME_BANK_ACCOUNT_VALIDATION_CHECK
- 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_MASKED_ACCOUNT_NUMBER
public static final String SERIALIZED_NAME_MASKED_ACCOUNT_NUMBER
- See Also:
- Constant Field Values
-
-
Method Detail
-
id
public PaymentInstrument id(String 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)
-
address
public PaymentInstrument address(Address 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)
-
application
public PaymentInstrument application(String application)
-
getApplication
@Nullable public String getApplication()
The ID of the resource.- Returns:
- application
-
setApplication
public void setApplication(String application)
-
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(String brand)
-
getBrand
@Nullable public String getBrand()
The `brand` of the card saved in the `Payment Instrument`.- Returns:
- brand
-
setBrand
public void setBrand(String 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(String cardType)
-
getCardType
@Nullable public String getCardType()
The type of payment card saved in the `Payment Instrument`.- Returns:
- cardType
-
setCardType
public void setCardType(String cardType)
-
currency
public PaymentInstrument currency(Currency currency)
-
setCurrency
public void setCurrency(Currency currency)
-
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)
-
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)
-
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)
-
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)
-
name
public PaymentInstrument name(String name)
-
setName
public void setName(String name)
-
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)
-
payloadType
public PaymentInstrument payloadType(PaymentInstrument.PayloadTypeEnum payloadType)
-
getPayloadType
@Nullable public PaymentInstrument.PayloadTypeEnum getPayloadType()
Get payloadType- Returns:
- payloadType
-
setPayloadType
public void setPayloadType(PaymentInstrument.PayloadTypeEnum payloadType)
-
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)
-
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
-
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)
-
links
public PaymentInstrument links(PaymentInstrumentLinks links)
-
getLinks
@Nullable public PaymentInstrumentLinks getLinks()
Get links- Returns:
- links
-
setLinks
public void setLinks(PaymentInstrumentLinks links)
-
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)
-
bankAccountValidationCheck
public PaymentInstrument bankAccountValidationCheck(PaymentInstrument.BankAccountValidationCheckEnum bankAccountValidationCheck)
-
getBankAccountValidationCheck
@Nullable public PaymentInstrument.BankAccountValidationCheckEnum getBankAccountValidationCheck()
Details the results of the bank account validation check if `attempt_bank_account_validation_check` is set to **true**.- Returns:
- bankAccountValidationCheck
-
setBankAccountValidationCheck
public void setBankAccountValidationCheck(PaymentInstrument.BankAccountValidationCheckEnum bankAccountValidationCheck)
-
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)
-
setCountry
public void setCountry(Country country)
-
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)
-
validateJsonObject
public static void validateJsonObject(com.google.gson.JsonObject jsonObj) throws IOExceptionValidates 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
-
-