FundingAccount
extends Base
in package
FundingAccount Class Doc Comment
Tags
Table of Contents
- DISCRIMINATOR = null
- $api_end_point : string
- $attributeMap : array<string|int, string>
- Array of attributes where the key is the local name, and the value is the original name
- $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
- $swaggerTypes : array<string|int, string>
- Array of property to type mappings. Used for (de)serialization
- $aba_routing_number : string
- $account_holder_name : string
- $account_holder_type : string
- $account_number : string
- $account_subtype : string
- $account_type : string
- $ach_eligible_flag : string
- $address : Address
- $atm_eligible_flag : string
- $audit_info : AuditInfo
- $card_cvv_number : string
- $comments : string
- $currency_code3d : string
- $custom_fields : mixed
- $deleted : string
- $device_manufacturer_id : string
- $display_text : string
- $expiry_date : string
- $http_status_code : mixed
- $id : string
- $id_customer : string
- $id_funding_account : string
- $invocation_context : InvocationContext
- $issuer_name : string
- $live_mode : string
- $nickname : string
- $status : string
- $url : string
- __construct() : mixed
- FundingAccount 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
- create() : FundingAccount
- create
- createdBy() : FundingAccount
- createdBy
- delete() : FundingAccount
- delete
- deletedBy() : FundingAccount
- deletedBy
- forClient() : mixed
- forCustomer() : mixed
- get() : FundingAccount
- get
- getAbaRoutingNumber() : string
- Gets aba_routing_number
- getAccountHolderName() : string
- Gets account_holder_name
- getAccountHolderType() : string
- Gets account_holder_type
- getAccountNumber() : string
- Gets account_number
- getAccountSubtype() : string
- Gets account_subtype
- getAccountType() : string
- Gets account_type
- getAchEligibleFlag() : string
- Gets ach_eligible_flag
- getAddress() : Address
- Gets address
- getApiEndPoint() : string
- getAtmEligibleFlag() : string
- Gets atm_eligible_flag
- getAuditInfo() : AuditInfo
- 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
- getHttpStatusCode() : mixed
- getId() : string
- Gets id
- getIdCustomer() : string
- Gets id_customer
- getIdFundingAccount() : string
- Gets id_funding_account
- getInvocationContext() : InvocationContext
- getIssuerName() : string
- Gets issuer_name
- getNickname() : string
- Gets nickname
- getStatus() : string
- Gets status
- getters() : array<string|int, mixed>
- Array of attributes to getter functions (for serialization of requests)
- getUrl() : string
- Gets url
- jsonSerialize() : mixed
- Specify data which should be serialized to JSON
- replace() : FundingAccount
- replace
- replacedBy() : FundingAccount
- replacedBy
- retrievedBy() : FundingAccount
- retrievedBy
- setInvocationContext() : mixed
- setters() : array<string|int, mixed>
- Array of attributes to setter functions (for deserialization of responses)
- 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
- update() : FundingAccount
- update
- updatedBy() : FundingAccount
- updatedBy
- videChannel() : mixed
- withAddress() : mixed
- withContext() : mixed
- withCustomFields() : mixed
- withDetails() : mixed
- withDeviceManufacturerId() : mixed
- withDisplayText() : mixed
- withMemo() : mixed
- withRecordedDetails() : mixed
- withStatus() : mixed
- requestedBy() : mixed
- setAPIEndpoint() : mixed
Constants
DISCRIMINATOR
public
mixed
DISCRIMINATOR
= null
Properties
$api_end_point
protected
string
$api_end_point
$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', 'id_customer' => 'ID_CUSTOMER', 'id_funding_account' => 'ID_FUNDING_ACCOUNT']
$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', 'id_customer' => 'getIdCustomer', 'id_funding_account' => 'getIdFundingAccount']
$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', 'id_customer' => 'setIdCustomer', 'id_funding_account' => 'setIdFundingAccount']
$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, 'id_customer' => null, 'id_funding_account' => null]
$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\Wrappers\Address', '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\Wrappers\AuditInfo', 'id_customer' => 'string', 'id_funding_account' => 'string']
$aba_routing_number
private
string
$aba_routing_number
$account_holder_name
private
string
$account_holder_name
$account_holder_type
private
string
$account_holder_type
$account_number
private
string
$account_number
$account_subtype
private
string
$account_subtype
$account_type
private
string
$account_type
$ach_eligible_flag
private
string
$ach_eligible_flag
$address
private
Address
$address
$atm_eligible_flag
private
string
$atm_eligible_flag
$audit_info
private
AuditInfo
$audit_info
$card_cvv_number
private
string
$card_cvv_number
$comments
private
string
$comments
$currency_code3d
private
string
$currency_code3d
$custom_fields
private
mixed
$custom_fields
$deleted
private
string
$deleted
$device_manufacturer_id
private
string
$device_manufacturer_id
$display_text
private
string
$display_text
$expiry_date
private
string
$expiry_date
$http_status_code
private
mixed
$http_status_code
$id
private
string
$id
$id_customer
private
string
$id_customer
$id_funding_account
private
string
$id_funding_account
$invocation_context
private
InvocationContext
$invocation_context
$issuer_name
private
string
$issuer_name
$live_mode
private
string
$live_mode
$nickname
private
string
$nickname
$status
private
string
$status
$url
private
string
$url
Methods
__construct()
FundingAccount constructor.
public
__construct([string $id_funding_account = null ]) : mixed
Parameters
- $id_funding_account : string = null
Return values
mixed —__toString()
Gets the string presentation of the object
public
__toString() : string
Return values
string —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> —create()
create
public
create(InvocationContext $invocationContext[, string $liveMode = null ][, string $apiEndPoint = null ]) : FundingAccount
Parameters
- $invocationContext : InvocationContext
- $liveMode : string = null
- $apiEndPoint : string = null
Tags
Return values
FundingAccount —createdBy()
createdBy
public
createdBy([ $requestor = null ][, $requestor_type = null ]) : FundingAccount
Parameters
Return values
FundingAccount —delete()
delete
public
delete(InvocationContext $invocationContext[, string $liveMode = null ][, string $apiEndPoint = null ]) : FundingAccount
Parameters
- $invocationContext : InvocationContext
- $liveMode : string = null
- $apiEndPoint : string = null
Tags
Return values
FundingAccount —deletedBy()
deletedBy
public
deletedBy([ $requestor = null ][, $requestor_type = null ]) : FundingAccount
Parameters
Return values
FundingAccount —forClient()
public
forClient([mixed $client_key = null ]) : mixed
Parameters
- $client_key : mixed = null
Return values
mixed —forCustomer()
public
forCustomer([mixed $id_customer = null ]) : mixed
Parameters
- $id_customer : mixed = null
Return values
mixed —get()
get
public
get(InvocationContext $invocationContext[, string $liveMode = null ][, string $apiEndPoint = null ]) : FundingAccount
Parameters
- $invocationContext : InvocationContext
- $liveMode : string = null
- $apiEndPoint : string = null
Tags
Return values
FundingAccount —getAbaRoutingNumber()
Gets aba_routing_number
public
getAbaRoutingNumber() : string
Return values
string —$aba_routing_number The ABA/Routing number for the bank account.
getAccountHolderName()
Gets account_holder_name
public
getAccountHolderName() : string
Return values
string —$account_holder_name The name as specified on the account.
getAccountHolderType()
Gets account_holder_type
public
getAccountHolderType() : string
Return values
string —$account_holder_type The type of ownership for the funding account. This is applicable only in the case of bank accounts and it is defaults to personal.
getAccountNumber()
Gets account_number
public
getAccountNumber() : string
Return values
string —$account_number 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.
getAccountSubtype()
Gets account_subtype
public
getAccountSubtype() : string
Return values
string —$account_subtype 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.
getAccountType()
Gets account_type
public
getAccountType() : string
Return values
string —$account_type The type of the funding account.
getAchEligibleFlag()
Gets ach_eligible_flag
public
getAchEligibleFlag() : string
Return values
string —$ach_eligible_flag Indicates if the funding account can be debited vide ACH, in case the funding account is a Demand Deposit Account (DDA).
getAddress()
Gets address
public
getAddress() : Address
Return values
Address —$address address
getApiEndPoint()
public
getApiEndPoint() : string
Return values
string —getAtmEligibleFlag()
Gets atm_eligible_flag
public
getAtmEligibleFlag() : string
Return values
string —$atm_eligible_flag Indicates if the funding account can be debited vide the ATM Rail network, in case the funding account is a Debit Card.
getAuditInfo()
Gets audit_info
public
getAuditInfo() : AuditInfo
Return values
AuditInfo —$audit_info audit_info
getCardCvvNumber()
Gets card_cvv_number
public
getCardCvvNumber() : string
Return values
string —$card_cvv_number This is never returned by Orbipay. This needs to be passed to Orbipay when adding or editing a card funding account.
getComments()
Gets comments
public
getComments() : string
Return values
string —$comments 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.
getCurrencyCode3d()
Gets currency_code3d
public
getCurrencyCode3d() : string
Return values
string —$currency_code3d 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.
getCustomFields()
Gets custom_fields
public
getCustomFields() : mixed
Return values
mixed —getDeleted()
Gets deleted
public
getDeleted() : string
Return values
string —$deleted The status of funding account which says whether the funding account is deleted or not
getDeviceManufacturerId()
Gets device_manufacturer_id
public
getDeviceManufacturerId() : string
Return values
string —$device_manufacturer_id This is applicable only for Apple Pay transactions. Hex-encoded device manufacturer identifier.
getDisplayText()
Gets display_text
public
getDisplayText() : string
Return values
string —$display_text UI representation of the account.
getExpiryDate()
Gets expiry_date
public
getExpiryDate() : string
Return values
string —$expiry_date The expiry date for the card. This is to be in the format MM/YY.
getHttpStatusCode()
public
getHttpStatusCode() : mixed
Return values
mixed —getId()
Gets id
public
getId() : string
Return values
string —$id 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.
getIdCustomer()
Gets id_customer
public
getIdCustomer() : string
Return values
string —$id_customer The unique identifier assigned by EBPP to the customer.
getIdFundingAccount()
Gets id_funding_account
public
getIdFundingAccount() : string
Return values
string —$id_funding_account The unique identifier assigned by EBPP to the Funding Account.
getInvocationContext()
public
getInvocationContext() : InvocationContext
Return values
InvocationContext —getIssuerName()
Gets issuer_name
public
getIssuerName() : string
Return values
string —$issuer_name The name of the authority that has issued the account. This is relevant only in the case of bank accounts.
getNickname()
Gets nickname
public
getNickname() : string
Return values
string —$nickname The nickname by which a customer might want to identify the account.
getStatus()
Gets status
public
getStatus() : string
Return values
string —$status The status of the funding account in Orbipay.
getters()
Array of attributes to getter functions (for serialization of requests)
public
static getters() : array<string|int, mixed>
Return values
array<string|int, mixed> —getUrl()
Gets url
public
getUrl() : string
Return values
string —$url This URL fetches the funding account details.
jsonSerialize()
Specify data which should be serialized to JSON
public
jsonSerialize() : mixed
Tags
Return values
mixed —data which can be serialized by json_encode, which is a value of any type other than a resource.
replace()
replace
public
replace(InvocationContext $invocationContext[, string $liveMode = null ][, string $apiEndPoint = null ]) : FundingAccount
Parameters
- $invocationContext : InvocationContext
- $liveMode : string = null
- $apiEndPoint : string = null
Tags
Return values
FundingAccount —replacedBy()
replacedBy
public
replacedBy([ $requestor = null ][, $requestor_type = null ]) : FundingAccount
Parameters
Return values
FundingAccount —retrievedBy()
retrievedBy
public
retrievedBy([ $requestor = null ][, $requestor_type = null ]) : FundingAccount
Parameters
Return values
FundingAccount —setInvocationContext()
public
setInvocationContext([InvocationContext $invocation_context = null ]) : mixed
Parameters
- $invocation_context : InvocationContext = null
Return values
mixed —setters()
Array of attributes to setter functions (for deserialization of responses)
public
static setters() : array<string|int, mixed>
Return values
array<string|int, mixed> —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> —update()
update
public
update(InvocationContext $invocationContext[, string $liveMode = null ][, string $apiEndPoint = null ]) : FundingAccount
Parameters
- $invocationContext : InvocationContext
- $liveMode : string = null
- $apiEndPoint : string = null
Tags
Return values
FundingAccount —updatedBy()
updatedBy
public
updatedBy([ $requestor = null ][, $requestor_type = null ]) : FundingAccount
Parameters
Return values
FundingAccount —videChannel()
public
videChannel([mixed $channel = null ]) : mixed
Parameters
- $channel : mixed = null
Return values
mixed —withAddress()
public
withAddress([mixed $address = null ]) : mixed
Parameters
- $address : mixed = null
Return values
mixed —withContext()
public
withContext(InvocationContext $request[, string $live_mode = null ][, string $apiEndPoint = null ]) : mixed
Parameters
- $request : InvocationContext
- $live_mode : string = null
- $apiEndPoint : string = null
Return values
mixed —withCustomFields()
public
withCustomFields([mixed $custom_fields = null ]) : mixed
Parameters
- $custom_fields : mixed = null
Return values
mixed —withDetails()
public
withDetails([mixed $account_holder_name = null ][, mixed $nickname = null ][, mixed $account_number = null ][, mixed $account_subtype = null ][, mixed $aba_routing_number = null ][, mixed $card_cvv_number = null ][, mixed $expiry_date = null ][, mixed $account_holder_type = null ]) : mixed
Parameters
- $account_holder_name : mixed = null
- $nickname : mixed = null
- $account_number : mixed = null
- $account_subtype : mixed = null
- $aba_routing_number : mixed = null
- $card_cvv_number : mixed = null
- $expiry_date : mixed = null
- $account_holder_type : mixed = null
Return values
mixed —withDeviceManufacturerId()
public
withDeviceManufacturerId([mixed $device_manufacturer_id = null ]) : mixed
Parameters
- $device_manufacturer_id : mixed = null
Return values
mixed —withDisplayText()
public
withDisplayText([mixed $display_text = null ]) : mixed
Parameters
- $display_text : mixed = null
Return values
mixed —withMemo()
public
withMemo([mixed $comments = null ]) : mixed
Parameters
- $comments : mixed = null
Return values
mixed —withRecordedDetails()
public
withRecordedDetails([mixed $account_number = null ][, mixed $issuer_name = null ]) : mixed
Parameters
- $account_number : mixed = null
- $issuer_name : mixed = null
Return values
mixed —withStatus()
public
withStatus([mixed $status = null ]) : mixed
Parameters
- $status : mixed = null
Return values
mixed —requestedBy()
protected
requestedBy(mixed $requestor, mixed $requestor_type) : mixed
Parameters
- $requestor : mixed
- $requestor_type : mixed
Return values
mixed —setAPIEndpoint()
protected
setAPIEndpoint([string $live_mode = null ][, string $apiEndPoint = null ]) : mixed
Parameters
- $live_mode : string = null
- $apiEndPoint : string = null