Documentation

CustomerAccount extends Base
in package

CustomerAccount Class Doc Comment

Tags
category

Class

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
$account_holder_name  : string
$account_number  : string
$address  : Address
$audit_info  : AuditInfo
$comments  : string
$current_balance  : string
$current_statement_balance  : string
$custom_fields  : mixed
$customer_account_reference  : string
$http_status_code  : mixed
$id  : string
$id_customer  : string
$id_customer_account  : string
$invocation_context  : InvocationContext
$live_mode  : string
$minimum_payment_due  : string
$nickname  : string
$past_amount_due  : string
$payment_due_date  : string
$payoff_amount  : string
$payoff_expiry_date  : string
$statement_date  : string
$status  : string
$url  : string
__construct()  : mixed
CustomerAccount 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
forClient()  : mixed
forCustomer()  : mixed
get()  : CustomerAccount
get
getAccountHolderName()  : string
Gets account_holder_name
getAccountNumber()  : string
Gets account_number
getAddress()  : Address
Gets address
getApiEndPoint()  : string
getAuditInfo()  : AuditInfo
Gets audit_info
getComments()  : string
Gets comments
getCurrentBalance()  : string
Gets current_balance
getCurrentStatementBalance()  : string
Gets current_statement_balance
getCustomerAccountReference()  : string
Gets customer_account_reference
getCustomFields()  : mixed
Gets custom_fields
getHttpStatusCode()  : mixed
getId()  : string
Gets id
getIdCustomer()  : string
Gets id_customer
getIdCustomerAccount()  : string
Gets id_customer_account
getInvocationContext()  : InvocationContext
getMinimumPaymentDue()  : string
Gets minimum_payment_due
getNickname()  : string
Gets nickname
getPastAmountDue()  : string
Gets past_amount_due
getPaymentDueDate()  : string
Gets payment_due_date
getPayoffAmount()  : string
Gets payoff_amount
getPayoffExpiryDate()  : string
Gets payoff_expiry_date
getStatementDate()  : string
Gets statement_date
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
renew()  : CustomerAccount
renew
renewedBy()  : CustomerAccount
renewedBy
retrievedBy()  : CustomerAccount
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
withAddress()  : mixed
withBalances()  : mixed
withContext()  : mixed
withCustomFields()  : mixed
withDetails()  : mixed
withMemo()  : mixed
withPayoffDetails()  : mixed
withReference()  : mixed
withStatus()  : mixed
requestedBy()  : mixed
setAPIEndpoint()  : mixed

Constants

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', 'customer_account_reference' => 'customer_account_reference', 'account_number' => 'account_number', 'current_balance' => 'current_balance', 'current_statement_balance' => 'current_statement_balance', 'minimum_payment_due' => 'minimum_payment_due', 'past_amount_due' => 'past_amount_due', 'payment_due_date' => 'payment_due_date', 'statement_date' => 'statement_date', 'payoff_amount' => 'payoff_amount', 'payoff_expiry_date' => 'payoff_expiry_date', 'id' => 'id', 'url' => 'url', 'status' => 'status', 'custom_fields' => 'custom_fields', 'comments' => 'comments', 'audit_info' => 'audit_info', 'id_customer_account' => 'ID_CUSTOMER_ACCOUNT', 'id_customer' => 'ID_CUSTOMER']

$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', 'customer_account_reference' => 'getCustomerAccountReference', 'account_number' => 'getAccountNumber', 'current_balance' => 'getCurrentBalance', 'current_statement_balance' => 'getCurrentStatementBalance', 'minimum_payment_due' => 'getMinimumPaymentDue', 'past_amount_due' => 'getPastAmountDue', 'payment_due_date' => 'getPaymentDueDate', 'statement_date' => 'getStatementDate', 'payoff_amount' => 'getPayoffAmount', 'payoff_expiry_date' => 'getPayoffExpiryDate', 'id' => 'getId', 'url' => 'getUrl', 'status' => 'getStatus', 'custom_fields' => 'getCustomFields', 'comments' => 'getComments', 'audit_info' => 'getAuditInfo', 'id_customer_account' => 'getIdCustomerAccount', 'id_customer' => 'getIdCustomer']

$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', 'customer_account_reference' => 'setCustomerAccountReference', 'account_number' => 'setAccountNumber', 'current_balance' => 'setCurrentBalance', 'current_statement_balance' => 'setCurrentStatementBalance', 'minimum_payment_due' => 'setMinimumPaymentDue', 'past_amount_due' => 'setPastAmountDue', 'payment_due_date' => 'setPaymentDueDate', 'statement_date' => 'setStatementDate', 'payoff_amount' => 'setPayoffAmount', 'payoff_expiry_date' => 'setPayoffExpiryDate', 'id' => 'setId', 'url' => 'setUrl', 'status' => 'setStatus', 'custom_fields' => 'setCustomFields', 'comments' => 'setComments', 'audit_info' => 'setAuditInfo', 'id_customer_account' => 'setIdCustomerAccount', 'id_customer' => 'setIdCustomer']

$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, 'customer_account_reference' => null, 'account_number' => null, 'current_balance' => null, 'current_statement_balance' => null, 'minimum_payment_due' => null, 'past_amount_due' => null, 'payment_due_date' => null, 'statement_date' => null, 'payoff_amount' => null, 'payoff_expiry_date' => null, 'id' => null, 'url' => null, 'status' => null, 'custom_fields' => null, 'comments' => null, 'audit_info' => null, 'id_customer_account' => null, 'id_customer' => 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', 'customer_account_reference' => 'string', 'account_number' => 'string', 'current_balance' => 'string', 'current_statement_balance' => 'string', 'minimum_payment_due' => 'string', 'past_amount_due' => 'string', 'payment_due_date' => 'string', 'statement_date' => 'string', 'payoff_amount' => 'string', 'payoff_expiry_date' => 'string', 'id' => 'string', 'url' => 'string', 'status' => 'string', 'custom_fields' => 'map[string,string]', 'comments' => 'string', 'audit_info' => '\Orbipay\PaymentsApi\Client\Wrappers\AuditInfo', 'id_customer_account' => 'string', 'id_customer' => 'string']

$current_statement_balance

private string $current_statement_balance

$customer_account_reference

private string $customer_account_reference

$http_status_code

private mixed $http_status_code

$live_mode

private string $live_mode

Methods

__construct()

CustomerAccount constructor.

public __construct([string $id_customer_account = null ]) : mixed
Parameters
$id_customer_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> —

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 —

getAccountHolderName()

Gets account_holder_name

public getAccountHolderName() : string
Return values
string —

$account_holder_name The name as specified on the account.

getAccountNumber()

Gets account_number

public getAccountNumber() : string
Return values
string —

$account_number The number or reference that a customer uses to identify the customer's account.

getApiEndPoint()

public getApiEndPoint() : string
Return values
string —

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 (EBPP) is not responsible for the security of any sensitive information that may be passed as part of the memo.

getCurrentBalance()

Gets current_balance

public getCurrentBalance() : string
Return values
string —

$current_balance The current balance on the customer's account with the biller.

getCurrentStatementBalance()

Gets current_statement_balance

public getCurrentStatementBalance() : string
Return values
string —

$current_statement_balance The balance on the customer’s account with the biller as reported on the last statement.

getCustomerAccountReference()

Gets customer_account_reference

public getCustomerAccountReference() : string
Return values
string —

$customer_account_reference The unique identifier in the client system for the customer account.

getCustomFields()

Gets custom_fields

public getCustomFields() : mixed
Return values
mixed —

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 customer account in EBPP.

getIdCustomer()

Gets id_customer

public getIdCustomer() : string
Return values
string —

$id_customer The unique identifier assigned by EBPP to the customer.

getIdCustomerAccount()

Gets id_customer_account

public getIdCustomerAccount() : string
Return values
string —

$id_customer_account The unique identifier assigned by EBPP to the Customer Account.

getMinimumPaymentDue()

Gets minimum_payment_due

public getMinimumPaymentDue() : string
Return values
string —

$minimum_payment_due The minimum payment amount, as specified by the biller, that needs to be made against the customer’s account.

getNickname()

Gets nickname

public getNickname() : string
Return values
string —

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

getPastAmountDue()

Gets past_amount_due

public getPastAmountDue() : string
Return values
string —

$past_amount_due The amount that is due from the past bills/statements on the customer’s account with the biller.

getPaymentDueDate()

Gets payment_due_date

public getPaymentDueDate() : string
Return values
string —

$payment_due_date The date by which the customer needs to clear the dues against the customer's account with the biller. It must be in ISO8601 full-date format, namely, YYYY-MM-DD.

getPayoffAmount()

Gets payoff_amount

public getPayoffAmount() : string
Return values
string —

$payoff_amount This field contains the computed current loan payoff amount at the time of inquiry for the customer’s account with the biller.

getPayoffExpiryDate()

Gets payoff_expiry_date

public getPayoffExpiryDate() : string
Return values
string —

$payoff_expiry_date The date till the payoff_amount is valid for the customer’s account with the biller. It must be in ISO8601 full-date format, namely, YYYY-MM-DD.

getStatementDate()

Gets statement_date

public getStatementDate() : string
Return values
string —

$statement_date The date on which the biller generates the statement for the customer's account. It must be in ISO8601 full-date format, namely, YYYY-MM-DD.

getStatus()

Gets status

public getStatus() : string
Return values
string —

$status The status of the customer's account in EBPP.

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 Account details.

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 —

withAddress()

public withAddress([mixed $address = null ]) : mixed
Parameters
$address : mixed = null
Return values
mixed —

withBalances()

public withBalances([mixed $current_balance = null ][, mixed $current_statement_balance = null ]) : mixed
Parameters
$current_balance : mixed = null
$current_statement_balance : 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 $minimum_payment_due = null ][, mixed $past_amount_due = null ][, mixed $payment_due_date = null ][, mixed $statement_date = null ]) : mixed
Parameters
$account_holder_name : mixed = null
$nickname : mixed = null
$account_number : mixed = null
$minimum_payment_due : mixed = null
$past_amount_due : mixed = null
$payment_due_date : mixed = null
$statement_date : mixed = null
Return values
mixed —

withMemo()

public withMemo([mixed $comments = null ]) : mixed
Parameters
$comments : mixed = null
Return values
mixed —

withPayoffDetails()

public withPayoffDetails([mixed $payoff_amount = null ][, mixed $payoff_expiry_date = null ]) : mixed
Parameters
$payoff_amount : mixed = null
$payoff_expiry_date : mixed = null
Return values
mixed —

withReference()

public withReference([mixed $customer_account_reference = null ]) : mixed
Parameters
$customer_account_reference : 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
Return values
mixed —

Search results