FundingAccounts
extends Base
in package
FundingAccounts 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_number : string
- $account_subtype : string
- $account_type : array<string|int, string>
- $from_index : string
- $has_more_results : string
- $http_status_code : mixed
- $id_customer : string
- $invocation_context : InvocationContext
- $list : array<string|int, FundingAccount>
- $live_mode : string
- $page_size : string
- $query_id : string
- $status : array<string|int, string>
- $to_index : string
- $total_results_count : string
- $url : string
- __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
- findBy() : mixed
- forClient() : mixed
- forCustomer() : mixed
- get() : FundingAccounts
- get
- getAbaRoutingNumber() : string
- Gets aba_routing_number
- getAccountNumber() : string
- Gets account_number
- getAccountSubtype() : string
- Gets account_subtype
- getAccountType() : array<string|int, string>
- Gets account_type
- getApiEndPoint() : string
- getFromIndex() : string
- Gets from_index
- getHasMoreResults() : string
- Gets has_more_results
- getHttpStatusCode() : mixed
- getIdCustomer() : string
- Gets id_customer
- getInvocationContext() : InvocationContext
- getList() : array<string|int, FundingAccount>
- Gets list
- getPage() : FundingAccounts
- getPage
- getPageSize() : string
- Gets page_size
- getQueryId() : string
- Gets query_id
- getStatus() : array<string|int, string>
- Gets status
- getters() : array<string|int, mixed>
- Array of attributes to getter functions (for serialization of requests)
- getToIndex() : string
- Gets to_index
- getTotalResultsCount() : string
- Gets total_results_count
- getUrl() : string
- Gets url
- jsonSerialize() : mixed
- Specify data which should be serialized to JSON
- retrievedBy() : FundingAccounts
- 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
- videChannel() : mixed
- withContext() : 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
= ['list' => 'list', 'total_results_count' => 'total_results_count', 'has_more_results' => 'has_more_results', 'url' => 'url', 'from_index' => 'from_index', 'to_index' => 'to_index', 'query_id' => 'query_id', 'id_customer' => 'ID_CUSTOMER', 'page_size' => 'page_size', 'account_number' => 'account_number', 'status' => 'status', 'aba_routing_number' => 'aba_routing_number', 'account_type' => 'account_type', 'account_subtype' => 'account_subtype']
$getters
Array of attributes to getter functions (for serialization of requests)
protected
static array<string|int, string>
$getters
= ['list' => 'getList', 'total_results_count' => 'getTotalResultsCount', 'has_more_results' => 'getHasMoreResults', 'url' => 'getUrl', 'from_index' => 'getFromIndex', 'to_index' => 'getToIndex', 'query_id' => 'getQueryId', 'id_customer' => 'getIdCustomer', 'page_size' => 'getPageSize', 'account_number' => 'getAccountNumber', 'status' => 'getStatus', 'aba_routing_number' => 'getAbaRoutingNumber', 'account_type' => 'getAccountType', 'account_subtype' => 'getAccountSubtype']
$setters
Array of attributes to setter functions (for deserialization of responses)
protected
static array<string|int, string>
$setters
= ['list' => 'setList', 'total_results_count' => 'setTotalResultsCount', 'has_more_results' => 'setHasMoreResults', 'url' => 'setUrl', 'from_index' => 'setFromIndex', 'to_index' => 'setToIndex', 'query_id' => 'setQueryId', 'id_customer' => 'setIdCustomer', 'page_size' => 'setPageSize', 'account_number' => 'setAccountNumber', 'status' => 'setStatus', 'aba_routing_number' => 'setAbaRoutingNumber', 'account_type' => 'setAccountType', 'account_subtype' => 'setAccountSubtype']
$swaggerFormats
Array of property to format mappings. Used for (de)serialization
protected
static array<string|int, string>
$swaggerFormats
= ['list' => null, 'total_results_count' => null, 'has_more_results' => null, 'url' => null, 'from_index' => null, 'to_index' => null, 'query_id' => null, 'id_customer' => null, 'page_size' => null, 'account_number' => null, 'status' => null, 'aba_routing_number' => null, 'account_type' => null, 'account_subtype' => null]
$swaggerTypes
Array of property to type mappings. Used for (de)serialization
protected
static array<string|int, string>
$swaggerTypes
= ['list' => '\Orbipay\PaymentsApi\Client\Wrappers\FundingAccount[]', 'total_results_count' => 'string', 'has_more_results' => 'string', 'url' => 'string', 'from_index' => 'string', 'to_index' => 'string', 'query_id' => 'string', 'id_customer' => 'string', 'page_size' => 'string', 'account_number' => 'string', 'status' => 'string[]', 'aba_routing_number' => 'string', 'account_type' => 'string[]', 'account_subtype' => 'string']
$aba_routing_number
private
string
$aba_routing_number
$account_number
private
string
$account_number
$account_subtype
private
string
$account_subtype
$account_type
private
array<string|int, string>
$account_type
$from_index
private
string
$from_index
$has_more_results
private
string
$has_more_results
$http_status_code
private
mixed
$http_status_code
$id_customer
private
string
$id_customer
$invocation_context
private
InvocationContext
$invocation_context
$list
private
array<string|int, FundingAccount>
$list
$live_mode
private
string
$live_mode
$page_size
private
string
$page_size
$query_id
private
string
$query_id
$status
private
array<string|int, string>
$status
$to_index
private
string
$to_index
$total_results_count
private
string
$total_results_count
$url
private
string
$url
Methods
__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> —findBy()
public
findBy([MultiMap $filterMap = null ]) : mixed
Parameters
- $filterMap : MultiMap = null
Return values
mixed —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 ]) : FundingAccounts
Parameters
- $invocationContext : InvocationContext
- $liveMode : string = null
- $apiEndPoint : string = null
Tags
Return values
FundingAccounts —getAbaRoutingNumber()
Gets aba_routing_number
public
getAbaRoutingNumber() : string
Return values
string —$aba_routing_number The ABA/Routing number for the bank account.
getAccountNumber()
Gets account_number
public
getAccountNumber() : string
Return values
string —$account_number The Account Number to get details of.
getAccountSubtype()
Gets account_subtype
public
getAccountSubtype() : string
Return values
string —$account_subtype The sub type of the funding account. This is derived by EBPP in the case of card funding accounts. It needs to be passed when adding or editing a DDA/bank account.
getAccountType()
Gets account_type
public
getAccountType() : array<string|int, string>
Return values
array<string|int, string> —$account_type The type of the funding account. This can take multiple values in the format key=value1&key=value2....
getApiEndPoint()
public
getApiEndPoint() : string
Return values
string —getFromIndex()
Gets from_index
public
getFromIndex() : string
Return values
string —$from_index The id of the object before which the previous set of objects are to be retrieved.
getHasMoreResults()
Gets has_more_results
public
getHasMoreResults() : string
Return values
string —$has_more_results true if there are more results or pages
getHttpStatusCode()
public
getHttpStatusCode() : mixed
Return values
mixed —getIdCustomer()
Gets id_customer
public
getIdCustomer() : string
Return values
string —$id_customer The unique identifier assigned by EBPP to the customer.
getInvocationContext()
public
getInvocationContext() : InvocationContext
Return values
InvocationContext —getList()
Gets list
public
getList() : array<string|int, FundingAccount>
Return values
array<string|int, FundingAccount> —$list list
getPage()
getPage
public
getPage(InvocationContext $invocationContext[, string $liveMode = null ][, string $apiEndPoint = null ]) : FundingAccounts
Parameters
- $invocationContext : InvocationContext
- $liveMode : string = null
- $apiEndPoint : string = null
Tags
Return values
FundingAccounts —getPageSize()
Gets page_size
public
getPageSize() : string
Return values
string —$page_size The maximum number of objects returned in the query.
getQueryId()
Gets query_id
public
getQueryId() : string
Return values
string —$query_id The query id of the object.
getStatus()
Gets status
public
getStatus() : array<string|int, string>
Return values
array<string|int, string> —$status The status of the funding account in EBPP. This can take multiple values in the format key=value1&key=value2....
getters()
Array of attributes to getter functions (for serialization of requests)
public
static getters() : array<string|int, mixed>
Return values
array<string|int, mixed> —getToIndex()
Gets to_index
public
getToIndex() : string
Return values
string —$to_index The id of the object after which the next set of objects are to be retrieved.
getTotalResultsCount()
Gets total_results_count
public
getTotalResultsCount() : string
Return values
string —$total_results_count The total number of funding accounts of the customer matching the search criteria.
getUrl()
Gets url
public
getUrl() : string
Return values
string —$url This URL fetches the next or previous set of funding accounts, based on the presence of after_object or before_object parameter.
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.
retrievedBy()
retrievedBy
public
retrievedBy([ $requestor = null ][, $requestor_type = null ]) : FundingAccounts
Parameters
Return values
FundingAccounts —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> —videChannel()
public
videChannel([mixed $channel = null ]) : mixed
Parameters
- $channel : 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 —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