Documentation

CustomerAccountResponse
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

DISCRIMINATOR  = null
STATUS_ACTIVE  = 'active'
STATUS_INACTIVE  = 'inactive'
STATUS_INBANKRUPTCY  = 'inbankruptcy'
STATUS_INCOLLECTIONS  = 'incollections'
$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
getAccountHolderName()  : string
Gets account_holder_name
getAccountNumber()  : string
Gets account_number
getAddress()  : AddressVo
Gets address
getAuditInfo()  : AuditInfoVo
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
getId()  : string
Gets id
getMinimumPaymentDue()  : string
Gets minimum_payment_due
getModelName()  : string
The original name of the model.
getNickname()  : string
Gets nickname
getPastAmountDue()  : string
Gets past_amount_due
getPaymentDueDate()  : string
Gets payment_due_date
getStatementDate()  : string
Gets statement_date
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.
setAccountHolderName()  : $this
Sets account_holder_name
setAccountNumber()  : $this
Sets account_number
setAddress()  : $this
Sets address
setAuditInfo()  : $this
Sets audit_info
setComments()  : $this
Sets comments
setCurrentBalance()  : $this
Sets current_balance
setCurrentStatementBalance()  : $this
Sets current_statement_balance
setCustomerAccountReference()  : $this
Sets customer_account_reference
setCustomFields()  : $this
Sets custom_fields
setId()  : $this
Sets id
setMinimumPaymentDue()  : $this
Sets minimum_payment_due
setNickname()  : $this
Sets nickname
setPastAmountDue()  : $this
Sets past_amount_due
setPaymentDueDate()  : $this
Sets payment_due_date
setStatementDate()  : $this
Sets statement_date
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

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', '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', 'id' => 'id', 'url' => 'url', 'status' => 'status', 'custom_fields' => 'custom_fields', 'comments' => 'comments', 'audit_info' => 'audit_info']

$container

Associative array for storing property values

protected array<string|int, mixed> $container = []

$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', 'id' => 'getId', 'url' => 'getUrl', 'status' => 'getStatus', 'custom_fields' => 'getCustomFields', 'comments' => 'getComments', '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', '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', 'id' => 'setId', 'url' => 'setUrl', 'status' => 'setStatus', 'custom_fields' => 'setCustomFields', 'comments' => 'setComments', '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, '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, 'id' => null, 'url' => null, 'status' => null, 'custom_fields' => null, 'comments' => null, 'audit_info' => null]

$swaggerModelName

The original name of the model.

protected static string $swaggerModelName = 'CustomerAccountResponse'

$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\AddressVo', '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', 'id' => 'string', 'url' => 'string', 'status' => 'string', 'custom_fields' => 'map[string,string]', 'comments' => '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 —

__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> —

getAccountHolderName()

Gets account_holder_name

public getAccountHolderName() : string
Return values
string —

getCurrentBalance()

Gets current_balance

public getCurrentBalance() : string
Return values
string —

getCurrentStatementBalance()

Gets current_statement_balance

public getCurrentStatementBalance() : string
Return values
string —

getCustomerAccountReference()

Gets customer_account_reference

public getCustomerAccountReference() : string
Return values
string —

getMinimumPaymentDue()

Gets minimum_payment_due

public getMinimumPaymentDue() : string
Return values
string —

getModelName()

The original name of the model.

public getModelName() : string
Return values
string —

getPastAmountDue()

Gets past_amount_due

public getPastAmountDue() : string
Return values
string —

getPaymentDueDate()

Gets payment_due_date

public getPaymentDueDate() : 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 —

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 —

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

Return values
$this —

setCurrentBalance()

Sets current_balance

public setCurrentBalance(string $current_balance) : $this
Parameters
$current_balance : string

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

Return values
$this —

setCurrentStatementBalance()

Sets current_statement_balance

public setCurrentStatementBalance(string $current_statement_balance) : $this
Parameters
$current_statement_balance : string

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

Return values
$this —

setCustomerAccountReference()

Sets customer_account_reference

public setCustomerAccountReference(string $customer_account_reference) : $this
Parameters
$customer_account_reference : string

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

Return values
$this —

setCustomFields()

Sets custom_fields

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

setId()

Sets id

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

Id is a unique identifier assigned to the customer account in EBPP.

Return values
$this —

setMinimumPaymentDue()

Sets minimum_payment_due

public setMinimumPaymentDue(string $minimum_payment_due) : $this
Parameters
$minimum_payment_due : string

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

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 —

setPastAmountDue()

Sets past_amount_due

public setPastAmountDue(string $past_amount_due) : $this
Parameters
$past_amount_due : string

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

Return values
$this —

setPaymentDueDate()

Sets payment_due_date

public setPaymentDueDate(string $payment_due_date) : $this
Parameters
$payment_due_date : string

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.

Return values
$this —

setStatementDate()

Sets statement_date

public setStatementDate(string $statement_date) : $this
Parameters
$statement_date : string

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.

Return values
$this —

setStatus()

Sets status

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

The status of the customer's account in EBPP.

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 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