Documentation

FundingAccountResponseCgen
in package
implements ModelInterface, ArrayAccess

Warning:

This class subject to change without prior notice, Please dont use this class directly.

Tags
category

Class

Interfaces, Classes and Traits

ModelInterface
Warning:
ArrayAccess

Table of Contents

ACCOUNT_HOLDER_TYPE_BUSINESS  = 'business'
ACCOUNT_HOLDER_TYPE_PERSONAL  = 'personal'
ACCOUNT_SUBTYPE_AMERICAN_EXPRESS_CREDIT  = 'american_express_credit'
ACCOUNT_SUBTYPE_APPLE_PAY  = 'apple_pay'
ACCOUNT_SUBTYPE_CHECKING  = 'checking'
ACCOUNT_SUBTYPE_DISCOVER_CREDIT  = 'discover_credit'
ACCOUNT_SUBTYPE_DISCOVER_DEBIT  = 'discover_debit'
ACCOUNT_SUBTYPE_GOOGLE_PAY  = 'google_pay'
ACCOUNT_SUBTYPE_MASTERCARD_CREDIT  = 'mastercard_credit'
ACCOUNT_SUBTYPE_MASTERCARD_DEBIT  = 'mastercard_debit'
ACCOUNT_SUBTYPE_MONEY_MARKET  = 'money_market'
ACCOUNT_SUBTYPE_SAVINGS  = 'savings'
ACCOUNT_SUBTYPE_VISA_CREDIT  = 'visa_credit'
ACCOUNT_SUBTYPE_VISA_DEBIT  = 'visa_debit'
ACCOUNT_SUBTYPE_VOYAGER_FLEET  = 'voyager_fleet'
ACCOUNT_TYPE_BANK  = 'bank'
ACCOUNT_TYPE_CLOSED_LOOP  = 'closed_loop'
ACCOUNT_TYPE_CREDIT_CARD  = 'credit_card'
ACCOUNT_TYPE_DEBIT_CARD  = 'debit_card'
ACCOUNT_TYPE_WALLET  = 'wallet'
ACH_ELIGIBLE_FLAG_NO  = 'no'
ACH_ELIGIBLE_FLAG_YES  = 'yes'
ATM_ELIGIBLE_FLAG_NO  = 'no'
ATM_ELIGIBLE_FLAG_YES  = 'yes'
DISCRIMINATOR  = null
STATUS_ACTIVE  = 'active'
STATUS_FROZEN  = 'frozen'
STATUS_INACTIVE  = 'inactive'
STATUS_UNUSABLE  = 'unusable'
STATUS_UNVERIFIED  = 'unverified'
$attributeMap  : array<string|int, string>
Array of attributes where the key is the local name, and the value is the original name
$container  : array<string|int, mixed>
Associative array for storing property values
$getters  : array<string|int, string>
Array of attributes to getter functions (for serialization of requests)
$setters  : array<string|int, string>
Array of attributes to setter functions (for deserialization of responses)
$swaggerFormats  : array<string|int, string>
Array of property to format mappings. Used for (de)serialization
$swaggerModelName  : string
The original name of the model.
$swaggerTypes  : array<string|int, string>
Array of property to type mappings. Used for (de)serialization
__construct()  : mixed
Constructor
__toString()  : string
Gets the string presentation of the object
attributeMap()  : array<string|int, mixed>
Array of attributes where the key is the local name, and the value is the original name
getAbaRoutingNumber()  : string
Gets aba_routing_number
getAccountHolderName()  : string
Gets account_holder_name
getAccountHolderType()  : string
Gets account_holder_type
getAccountHolderTypeAllowableValues()  : array<string|int, string>
Gets allowable values of the enum
getAccountNumber()  : string
Gets account_number
getAccountSubtype()  : string
Gets account_subtype
getAccountSubtypeAllowableValues()  : array<string|int, string>
Gets allowable values of the enum
getAccountType()  : string
Gets account_type
getAccountTypeAllowableValues()  : array<string|int, string>
Gets allowable values of the enum
getAchEligibleFlag()  : string
Gets ach_eligible_flag
getAchEligibleFlagAllowableValues()  : array<string|int, string>
Gets allowable values of the enum
getAddress()  : FundingAccountAddress
Gets address
getAtmEligibleFlag()  : string
Gets atm_eligible_flag
getAtmEligibleFlagAllowableValues()  : array<string|int, string>
Gets allowable values of the enum
getAuditInfo()  : AuditInfoVo
Gets audit_info
getCardCvvNumber()  : string
Gets card_cvv_number
getComments()  : string
Gets comments
getCurrencyCode3d()  : string
Gets currency_code3d
getCustomFields()  : mixed
Gets custom_fields
getDeleted()  : string
Gets deleted
getDeviceManufacturerId()  : string
Gets device_manufacturer_id
getDisplayText()  : string
Gets display_text
getExpiryDate()  : string
Gets expiry_date
getId()  : string
Gets id
getIssuerName()  : string
Gets issuer_name
getModelName()  : string
The original name of the model.
getNickname()  : string
Gets nickname
getStatus()  : string
Gets status
getStatusAllowableValues()  : array<string|int, string>
Gets allowable values of the enum
getters()  : array<string|int, mixed>
Array of attributes to getter functions (for serialization of requests)
getUrl()  : string
Gets url
offsetExists()  : bool
Returns true if offset exists. False otherwise.
offsetGet()  : mixed
Gets offset.
offsetSet()  : void
Sets value based on offset.
offsetUnset()  : void
Unsets offset.
setAbaRoutingNumber()  : $this
Sets aba_routing_number
setAccountHolderName()  : $this
Sets account_holder_name
setAccountHolderType()  : $this
Sets account_holder_type
setAccountNumber()  : $this
Sets account_number
setAccountSubtype()  : $this
Sets account_subtype
setAccountType()  : $this
Sets account_type
setAchEligibleFlag()  : $this
Sets ach_eligible_flag
setAddress()  : $this
Sets address
setAtmEligibleFlag()  : $this
Sets atm_eligible_flag
setAuditInfo()  : $this
Sets audit_info
setCardCvvNumber()  : $this
Sets card_cvv_number
setComments()  : $this
Sets comments
setCurrencyCode3d()  : $this
Sets currency_code3d
setCustomFields()  : $this
Sets custom_fields
setDeleted()  : $this
Sets deleted
setDeviceManufacturerId()  : $this
Sets device_manufacturer_id
setDisplayText()  : $this
Sets display_text
setExpiryDate()  : $this
Sets expiry_date
setId()  : $this
Sets id
setIssuerName()  : $this
Sets issuer_name
setNickname()  : $this
Sets nickname
setStatus()  : $this
Sets status
setters()  : array<string|int, mixed>
Array of attributes to setter functions (for deserialization of responses)
setUrl()  : $this
Sets url
swaggerFormats()  : array<string|int, mixed>
Array of property to format mappings. Used for (de)serialization
swaggerTypes()  : array<string|int, mixed>
Array of property to type mappings. Used for (de)serialization

Constants

ACCOUNT_SUBTYPE_AMERICAN_EXPRESS_CREDIT

public mixed ACCOUNT_SUBTYPE_AMERICAN_EXPRESS_CREDIT = 'american_express_credit'

Properties

$attributeMap

Array of attributes where the key is the local name, and the value is the original name

protected static array<string|int, string> $attributeMap = ['account_holder_name' => 'account_holder_name', 'nickname' => 'nickname', 'address' => 'address', 'account_number' => 'account_number', 'aba_routing_number' => 'aba_routing_number', 'issuer_name' => 'issuer_name', 'currency_code3d' => 'currency_code3d', 'expiry_date' => 'expiry_date', 'account_holder_type' => 'account_holder_type', 'custom_fields' => 'custom_fields', 'account_subtype' => 'account_subtype', 'id' => 'id', 'url' => 'url', 'ach_eligible_flag' => 'ach_eligible_flag', 'atm_eligible_flag' => 'atm_eligible_flag', 'card_cvv_number' => 'card_cvv_number', 'account_type' => 'account_type', 'status' => 'status', 'device_manufacturer_id' => 'device_manufacturer_id', 'display_text' => 'display_text', 'comments' => 'comments', 'deleted' => 'deleted', 'audit_info' => 'audit_info']

$getters

Array of attributes to getter functions (for serialization of requests)

protected static array<string|int, string> $getters = ['account_holder_name' => 'getAccountHolderName', 'nickname' => 'getNickname', 'address' => 'getAddress', 'account_number' => 'getAccountNumber', 'aba_routing_number' => 'getAbaRoutingNumber', 'issuer_name' => 'getIssuerName', 'currency_code3d' => 'getCurrencyCode3d', 'expiry_date' => 'getExpiryDate', 'account_holder_type' => 'getAccountHolderType', 'custom_fields' => 'getCustomFields', 'account_subtype' => 'getAccountSubtype', 'id' => 'getId', 'url' => 'getUrl', 'ach_eligible_flag' => 'getAchEligibleFlag', 'atm_eligible_flag' => 'getAtmEligibleFlag', 'card_cvv_number' => 'getCardCvvNumber', 'account_type' => 'getAccountType', 'status' => 'getStatus', 'device_manufacturer_id' => 'getDeviceManufacturerId', 'display_text' => 'getDisplayText', 'comments' => 'getComments', 'deleted' => 'getDeleted', 'audit_info' => 'getAuditInfo']

$setters

Array of attributes to setter functions (for deserialization of responses)

protected static array<string|int, string> $setters = ['account_holder_name' => 'setAccountHolderName', 'nickname' => 'setNickname', 'address' => 'setAddress', 'account_number' => 'setAccountNumber', 'aba_routing_number' => 'setAbaRoutingNumber', 'issuer_name' => 'setIssuerName', 'currency_code3d' => 'setCurrencyCode3d', 'expiry_date' => 'setExpiryDate', 'account_holder_type' => 'setAccountHolderType', 'custom_fields' => 'setCustomFields', 'account_subtype' => 'setAccountSubtype', 'id' => 'setId', 'url' => 'setUrl', 'ach_eligible_flag' => 'setAchEligibleFlag', 'atm_eligible_flag' => 'setAtmEligibleFlag', 'card_cvv_number' => 'setCardCvvNumber', 'account_type' => 'setAccountType', 'status' => 'setStatus', 'device_manufacturer_id' => 'setDeviceManufacturerId', 'display_text' => 'setDisplayText', 'comments' => 'setComments', 'deleted' => 'setDeleted', 'audit_info' => 'setAuditInfo']

$swaggerFormats

Array of property to format mappings. Used for (de)serialization

protected static array<string|int, string> $swaggerFormats = ['account_holder_name' => null, 'nickname' => null, 'address' => null, 'account_number' => null, 'aba_routing_number' => null, 'issuer_name' => null, 'currency_code3d' => null, 'expiry_date' => null, 'account_holder_type' => null, 'custom_fields' => null, 'account_subtype' => null, 'id' => null, 'url' => null, 'ach_eligible_flag' => null, 'atm_eligible_flag' => null, 'card_cvv_number' => null, 'account_type' => null, 'status' => null, 'device_manufacturer_id' => null, 'display_text' => null, 'comments' => null, 'deleted' => null, 'audit_info' => null]

$swaggerModelName

The original name of the model.

protected static string $swaggerModelName = 'FundingAccountResponseCgen'

$swaggerTypes

Array of property to type mappings. Used for (de)serialization

protected static array<string|int, string> $swaggerTypes = ['account_holder_name' => 'string', 'nickname' => 'string', 'address' => '\Orbipay\PaymentsApi\Client\Model\FundingAccountAddress', 'account_number' => 'string', 'aba_routing_number' => 'string', 'issuer_name' => 'string', 'currency_code3d' => 'string', 'expiry_date' => 'string', 'account_holder_type' => 'string', 'custom_fields' => 'map[string,string]', 'account_subtype' => 'string', 'id' => 'string', 'url' => 'string', 'ach_eligible_flag' => 'string', 'atm_eligible_flag' => 'string', 'card_cvv_number' => 'string', 'account_type' => 'string', 'status' => 'string', 'device_manufacturer_id' => 'string', 'display_text' => 'string', 'comments' => 'string', 'deleted' => 'string', 'audit_info' => '\Orbipay\PaymentsApi\Client\Model\AuditInfoVo']

Methods

__construct()

Constructor

public __construct([array<string|int, mixed> $data = null ]) : mixed
Parameters
$data : array<string|int, mixed> = null

Associated array of property values initializing the model

Return values
mixed —

attributeMap()

Array of attributes where the key is the local name, and the value is the original name

public static attributeMap() : array<string|int, mixed>
Return values
array<string|int, mixed> —

getAccountHolderName()

Gets account_holder_name

public getAccountHolderName() : string
Return values
string —

getAccountHolderType()

Gets account_holder_type

public getAccountHolderType() : string
Return values
string —

getAccountHolderTypeAllowableValues()

Gets allowable values of the enum

public getAccountHolderTypeAllowableValues() : array<string|int, string>
Return values
array<string|int, string> —

getAccountSubtypeAllowableValues()

Gets allowable values of the enum

public getAccountSubtypeAllowableValues() : array<string|int, string>
Return values
array<string|int, string> —

getAccountTypeAllowableValues()

Gets allowable values of the enum

public getAccountTypeAllowableValues() : array<string|int, string>
Return values
array<string|int, string> —

getAchEligibleFlagAllowableValues()

Gets allowable values of the enum

public getAchEligibleFlagAllowableValues() : array<string|int, string>
Return values
array<string|int, string> —

getAtmEligibleFlagAllowableValues()

Gets allowable values of the enum

public getAtmEligibleFlagAllowableValues() : array<string|int, string>
Return values
array<string|int, string> —

getDeviceManufacturerId()

Gets device_manufacturer_id

public getDeviceManufacturerId() : string
Return values
string —

getStatusAllowableValues()

Gets allowable values of the enum

public getStatusAllowableValues() : array<string|int, string>
Return values
array<string|int, string> —

getters()

Array of attributes to getter functions (for serialization of requests)

public static getters() : array<string|int, mixed>
Return values
array<string|int, mixed> —

offsetExists()

Returns true if offset exists. False otherwise.

public offsetExists(int $offset) : bool
Parameters
$offset : int

Offset

Return values
bool —

offsetGet()

Gets offset.

public offsetGet(int $offset) : mixed
Parameters
$offset : int

Offset

Return values
mixed —

offsetSet()

Sets value based on offset.

public offsetSet(int $offset, mixed $value) : void
Parameters
$offset : int

Offset

$value : mixed

Value to be set

Return values
void —

offsetUnset()

Unsets offset.

public offsetUnset(int $offset) : void
Parameters
$offset : int

Offset

Return values
void —

setAbaRoutingNumber()

Sets aba_routing_number

public setAbaRoutingNumber(string $aba_routing_number) : $this
Parameters
$aba_routing_number : string

The ABA/Routing number for the bank account.

Return values
$this —

setAccountHolderName()

Sets account_holder_name

public setAccountHolderName(string $account_holder_name) : $this
Parameters
$account_holder_name : string

The name as specified on the account.

Return values
$this —

setAccountHolderType()

Sets account_holder_type

public setAccountHolderType(string $account_holder_type) : $this
Parameters
$account_holder_type : string

The type of ownership for the funding account. This is applicable only in the case of bank accounts and it is defaults to personal.

Return values
$this —

setAccountNumber()

Sets account_number

public setAccountNumber(string $account_number) : $this
Parameters
$account_number : string

The number or reference that a customer uses to identify the funding account. In case of Apple Pay, this is the device-specific account number of the card.

Return values
$this —

setAccountSubtype()

Sets account_subtype

public setAccountSubtype(string $account_subtype) : $this
Parameters
$account_subtype : string

The sub type of the funding account. This is derived by Orbipay in the case of card funding accounts. It needs to be passed when adding or editing a DDA/Bank/ApplePay account. For e.g., a savings account, a checking account.

Return values
$this —

setAccountType()

Sets account_type

public setAccountType(string $account_type) : $this
Parameters
$account_type : string

The type of the funding account.

Return values
$this —

setAchEligibleFlag()

Sets ach_eligible_flag

public setAchEligibleFlag(string $ach_eligible_flag) : $this
Parameters
$ach_eligible_flag : string

Indicates if the funding account can be debited vide ACH, in case the funding account is a Demand Deposit Account (DDA).

Return values
$this —

setAtmEligibleFlag()

Sets atm_eligible_flag

public setAtmEligibleFlag(string $atm_eligible_flag) : $this
Parameters
$atm_eligible_flag : string

Indicates if the funding account can be debited vide the ATM Rail network, in case the funding account is a Debit Card.

Return values
$this —

setCardCvvNumber()

Sets card_cvv_number

public setCardCvvNumber(string $card_cvv_number) : $this
Parameters
$card_cvv_number : string

This is never returned by Orbipay. This needs to be passed to Orbipay when adding or editing a card funding account.

Return values
$this —

setComments()

Sets comments

public setComments(string $comments) : $this
Parameters
$comments : string

Comments that can be used to recollect the operation performed on the resource object. API clients need to ensure that no sensitive information is passed in the memo. Alacriti (Orbipay) is not responsible for the security of any sensitive information that may be passed as part of the memo.

Return values
$this —

setCurrencyCode3d()

Sets currency_code3d

public setCurrencyCode3d(string $currency_code3d) : $this
Parameters
$currency_code3d : string

The three-letter currency code in the ISO4217 format, in uppercase, for the card account. It must be a currency supported by Orbipay. This defaults to USD.

Return values
$this —

setCustomFields()

Sets custom_fields

public setCustomFields(mixed $custom_fields) : $this
Parameters
$custom_fields : mixed
Return values
$this —

setDeleted()

Sets deleted

public setDeleted(string $deleted) : $this
Parameters
$deleted : string

The status of funding account which says whether the funding account is deleted or not

Return values
$this —

setDeviceManufacturerId()

Sets device_manufacturer_id

public setDeviceManufacturerId(string $device_manufacturer_id) : $this
Parameters
$device_manufacturer_id : string

This is applicable only for Apple Pay transactions. Hex-encoded device manufacturer identifier.

Return values
$this —

setDisplayText()

Sets display_text

public setDisplayText(string $display_text) : $this
Parameters
$display_text : string

UI representation of the account.

Return values
$this —

setExpiryDate()

Sets expiry_date

public setExpiryDate(string $expiry_date) : $this
Parameters
$expiry_date : string

The expiry date for the card. This is to be in the format MM/YY.

Return values
$this —

setId()

Sets id

public setId(string $id) : $this
Parameters
$id : string

Id is a unique identifier assigned to the funding account in Orbipay. A new Id is generated for the funding account when the account number is updated.

Return values
$this —

setIssuerName()

Sets issuer_name

public setIssuerName(string $issuer_name) : $this
Parameters
$issuer_name : string

The name of the authority that has issued the account. This is relevant only in the case of bank accounts.

Return values
$this —

setNickname()

Sets nickname

public setNickname(string $nickname) : $this
Parameters
$nickname : string

The nickname by which a customer might want to identify the account.

Return values
$this —

setStatus()

Sets status

public setStatus(string $status) : $this
Parameters
$status : string

The status of the funding account in Orbipay.

Return values
$this —

setters()

Array of attributes to setter functions (for deserialization of responses)

public static setters() : array<string|int, mixed>
Return values
array<string|int, mixed> —

setUrl()

Sets url

public setUrl(string $url) : $this
Parameters
$url : string

This URL fetches the funding account details.

Return values
$this —

swaggerFormats()

Array of property to format mappings. Used for (de)serialization

public static swaggerFormats() : array<string|int, mixed>
Return values
array<string|int, mixed> —

swaggerTypes()

Array of property to type mappings. Used for (de)serialization

public static swaggerTypes() : array<string|int, mixed>
Return values
array<string|int, mixed> —

Search results