Documentation

RecordedPaymentResponse
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
PAYMENT_AMOUNT_TYPE_CURRENT_BALANCE  = 'current_balance'
PAYMENT_AMOUNT_TYPE_MINIMUM_PAYMENT_DUE  = 'minimum_payment_due'
PAYMENT_AMOUNT_TYPE_OTHER  = 'other'
PAYMENT_AMOUNT_TYPE_PAST_PAYMENT_DUE  = 'past_payment_due'
PAYMENT_AMOUNT_TYPE_PAYDOWN_AMOUNT  = 'paydown_amount'
PAYMENT_AMOUNT_TYPE_PAYOFF_AMOUNT  = 'payoff_amount'
PAYMENT_AMOUNT_TYPE_STATEMENT_BALANCE  = 'statement_balance'
PAYMENT_METHOD_CASH  = 'cash'
PAYMENT_METHOD_SCANNED_CHECK  = 'scanned_check'
PAYMENT_METHOD_SWIPED_CARD  = 'swiped_card'
PAYMENT_SCHEDULE_TYPE_ONE_TIME_PAYMENT  = 'one_time_payment'
STATUS_CANCELLED  = 'cancelled'
STATUS_PROCESSED  = 'processed'
$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
getAmount()  : string
Gets amount
getAuditInfo()  : AuditInfoVo
Gets audit_info
getComments()  : string
Gets comments
getConfirmationNumber()  : string
Gets confirmation_number
getCurrencyCode3d()  : string
Gets currency_code3d
getCustomer()  : SimplePaymentCustomerResponse
Gets customer
getCustomerAccount()  : CustomerAccountResponse
Gets customer_account
getCustomFields()  : mixed
Gets custom_fields
getFee()  : FeeResponse
Gets fee
getFundingAccount()  : RecordedPaymentFundingAccount
Gets funding_account
getId()  : string
Gets id
getModelName()  : string
The original name of the model.
getPaymentAmountType()  : string
Gets payment_amount_type
getPaymentAmountTypeAllowableValues()  : array<string|int, string>
Gets allowable values of the enum
getPaymentDate()  : string
Gets payment_date
getPaymentEntryDate()  : string
Gets payment_entry_date
getPaymentMethod()  : string
Gets payment_method
getPaymentMethodAllowableValues()  : array<string|int, string>
Gets allowable values of the enum
getPaymentReference()  : string
Gets payment_reference
getPaymentReturnDate()  : string
Gets payment_return_date
getPaymentScheduleType()  : string
Gets payment_schedule_type
getPaymentScheduleTypeAllowableValues()  : array<string|int, string>
Gets allowable values of the enum
getReturnCode()  : string
Gets return_code
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)
getToken()  : string
Gets token
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.
setAmount()  : $this
Sets amount
setAuditInfo()  : $this
Sets audit_info
setComments()  : $this
Sets comments
setConfirmationNumber()  : $this
Sets confirmation_number
setCurrencyCode3d()  : $this
Sets currency_code3d
setCustomer()  : $this
Sets customer
setCustomerAccount()  : $this
Sets customer_account
setCustomFields()  : $this
Sets custom_fields
setFee()  : $this
Sets fee
setFundingAccount()  : $this
Sets funding_account
setId()  : $this
Sets id
setPaymentAmountType()  : $this
Sets payment_amount_type
setPaymentDate()  : $this
Sets payment_date
setPaymentEntryDate()  : $this
Sets payment_entry_date
setPaymentMethod()  : $this
Sets payment_method
setPaymentReference()  : $this
Sets payment_reference
setPaymentReturnDate()  : $this
Sets payment_return_date
setPaymentScheduleType()  : $this
Sets payment_schedule_type
setReturnCode()  : $this
Sets return_code
setStatus()  : $this
Sets status
setters()  : array<string|int, mixed>
Array of attributes to setter functions (for deserialization of responses)
setToken()  : $this
Sets token
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

PAYMENT_AMOUNT_TYPE_CURRENT_BALANCE

public mixed PAYMENT_AMOUNT_TYPE_CURRENT_BALANCE = 'current_balance'

PAYMENT_AMOUNT_TYPE_MINIMUM_PAYMENT_DUE

public mixed PAYMENT_AMOUNT_TYPE_MINIMUM_PAYMENT_DUE = 'minimum_payment_due'

PAYMENT_AMOUNT_TYPE_PAST_PAYMENT_DUE

public mixed PAYMENT_AMOUNT_TYPE_PAST_PAYMENT_DUE = 'past_payment_due'

PAYMENT_AMOUNT_TYPE_PAYDOWN_AMOUNT

public mixed PAYMENT_AMOUNT_TYPE_PAYDOWN_AMOUNT = 'paydown_amount'

PAYMENT_AMOUNT_TYPE_STATEMENT_BALANCE

public mixed PAYMENT_AMOUNT_TYPE_STATEMENT_BALANCE = 'statement_balance'

PAYMENT_SCHEDULE_TYPE_ONE_TIME_PAYMENT

public mixed PAYMENT_SCHEDULE_TYPE_ONE_TIME_PAYMENT = 'one_time_payment'

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 = ['id' => 'id', 'url' => 'url', 'fee' => 'fee', 'status' => 'status', 'payment_method' => 'payment_method', 'token' => 'token', 'confirmation_number' => 'confirmation_number', 'custom_fields' => 'custom_fields', 'currency_code3d' => 'currency_code3d', 'amount' => 'amount', 'payment_date' => 'payment_date', 'payment_schedule_type' => 'payment_schedule_type', 'payment_amount_type' => 'payment_amount_type', 'payment_reference' => 'payment_reference', 'payment_entry_date' => 'payment_entry_date', 'payment_return_date' => 'payment_return_date', 'comments' => 'comments', 'return_code' => 'return_code', 'customer' => 'customer', 'funding_account' => 'funding_account', 'customer_account' => 'customer_account', '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 = ['id' => 'getId', 'url' => 'getUrl', 'fee' => 'getFee', 'status' => 'getStatus', 'payment_method' => 'getPaymentMethod', 'token' => 'getToken', 'confirmation_number' => 'getConfirmationNumber', 'custom_fields' => 'getCustomFields', 'currency_code3d' => 'getCurrencyCode3d', 'amount' => 'getAmount', 'payment_date' => 'getPaymentDate', 'payment_schedule_type' => 'getPaymentScheduleType', 'payment_amount_type' => 'getPaymentAmountType', 'payment_reference' => 'getPaymentReference', 'payment_entry_date' => 'getPaymentEntryDate', 'payment_return_date' => 'getPaymentReturnDate', 'comments' => 'getComments', 'return_code' => 'getReturnCode', 'customer' => 'getCustomer', 'funding_account' => 'getFundingAccount', 'customer_account' => 'getCustomerAccount', 'audit_info' => 'getAuditInfo']

$setters

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

protected static array<string|int, string> $setters = ['id' => 'setId', 'url' => 'setUrl', 'fee' => 'setFee', 'status' => 'setStatus', 'payment_method' => 'setPaymentMethod', 'token' => 'setToken', 'confirmation_number' => 'setConfirmationNumber', 'custom_fields' => 'setCustomFields', 'currency_code3d' => 'setCurrencyCode3d', 'amount' => 'setAmount', 'payment_date' => 'setPaymentDate', 'payment_schedule_type' => 'setPaymentScheduleType', 'payment_amount_type' => 'setPaymentAmountType', 'payment_reference' => 'setPaymentReference', 'payment_entry_date' => 'setPaymentEntryDate', 'payment_return_date' => 'setPaymentReturnDate', 'comments' => 'setComments', 'return_code' => 'setReturnCode', 'customer' => 'setCustomer', 'funding_account' => 'setFundingAccount', 'customer_account' => 'setCustomerAccount', 'audit_info' => 'setAuditInfo']

$swaggerFormats

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

protected static array<string|int, string> $swaggerFormats = ['id' => null, 'url' => null, 'fee' => null, 'status' => null, 'payment_method' => null, 'token' => null, 'confirmation_number' => null, 'custom_fields' => null, 'currency_code3d' => null, 'amount' => null, 'payment_date' => null, 'payment_schedule_type' => null, 'payment_amount_type' => null, 'payment_reference' => null, 'payment_entry_date' => null, 'payment_return_date' => null, 'comments' => null, 'return_code' => null, 'customer' => null, 'funding_account' => null, 'customer_account' => null, 'audit_info' => null]

$swaggerModelName

The original name of the model.

protected static string $swaggerModelName = 'RecordedPaymentResponse'

$swaggerTypes

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

protected static array<string|int, string> $swaggerTypes = ['id' => 'string', 'url' => 'string', 'fee' => '\Orbipay\PaymentsApi\Client\Model\FeeResponse', 'status' => 'string', 'payment_method' => 'string', 'token' => 'string', 'confirmation_number' => 'string', 'custom_fields' => 'map[string,string]', 'currency_code3d' => 'string', 'amount' => 'string', 'payment_date' => 'string', 'payment_schedule_type' => 'string', 'payment_amount_type' => 'string', 'payment_reference' => 'string', 'payment_entry_date' => 'string', 'payment_return_date' => 'string', 'comments' => 'string', 'return_code' => 'string', 'customer' => '\Orbipay\PaymentsApi\Client\Model\SimplePaymentCustomerResponse', 'funding_account' => '\Orbipay\PaymentsApi\Client\Model\RecordedPaymentFundingAccount', 'customer_account' => '\Orbipay\PaymentsApi\Client\Model\CustomerAccountResponse', '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> —

getConfirmationNumber()

Gets confirmation_number

public getConfirmationNumber() : string
Return values
string —

getCurrencyCode3d()

Gets currency_code3d

public getCurrencyCode3d() : string
Return values
string —

getModelName()

The original name of the model.

public getModelName() : string
Return values
string —

getPaymentAmountType()

Gets payment_amount_type

public getPaymentAmountType() : string
Return values
string —

getPaymentAmountTypeAllowableValues()

Gets allowable values of the enum

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

getPaymentEntryDate()

Gets payment_entry_date

public getPaymentEntryDate() : string
Return values
string —

getPaymentMethodAllowableValues()

Gets allowable values of the enum

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

getPaymentReference()

Gets payment_reference

public getPaymentReference() : string
Return values
string —

getPaymentReturnDate()

Gets payment_return_date

public getPaymentReturnDate() : string
Return values
string —

getPaymentScheduleType()

Gets payment_schedule_type

public getPaymentScheduleType() : string
Return values
string —

getPaymentScheduleTypeAllowableValues()

Gets allowable values of the enum

public getPaymentScheduleTypeAllowableValues() : array<string|int, string>
Return values
array<string|int, 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 —

setAmount()

Sets amount

public setAmount(string $amount) : $this
Parameters
$amount : string

The amount being paid. In case the payment_amount_type is 'other', the amount needs to be specified. In other cases, this is derived from the payment_amount_type.

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.

Return values
$this —

setConfirmationNumber()

Sets confirmation_number

public setConfirmationNumber(string $confirmation_number) : $this
Parameters
$confirmation_number : string

The confirmation number or reference provided to the customer for the payment.

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 EBPP. This defaults to USD.

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

The unique identifier assigned by EBPP to the payment.

Return values
$this —

setPaymentAmountType()

Sets payment_amount_type

public setPaymentAmountType(string $payment_amount_type) : $this
Parameters
$payment_amount_type : string

The type of amount, as per the bill/statement, that is being paid. The payment amount is derived from the amount type selected for the payment. This defaults to other.

Return values
$this —

setPaymentDate()

Sets payment_date

public setPaymentDate(string $payment_date) : $this
Parameters
$payment_date : string

The date on which the payment is scheduled to be made. It must be in ISO8601 full-date format, namely, YYYY-MM-DD.

Return values
$this —

setPaymentEntryDate()

Sets payment_entry_date

public setPaymentEntryDate(string $payment_entry_date) : $this
Parameters
$payment_entry_date : string

The date on which the payment is captured in EBPP. It must be in ISO8601 full-date format, namely, YYYY-MM-DD.

Return values
$this —

setPaymentMethod()

Sets payment_method

public setPaymentMethod(string $payment_method) : $this
Parameters
$payment_method : string

The non fulfillment method for the payment.

Return values
$this —

setPaymentReference()

Sets payment_reference

public setPaymentReference(string $payment_reference) : $this
Parameters
$payment_reference : string

The unique identifier in the client system for the payment.

Return values
$this —

setPaymentReturnDate()

Sets payment_return_date

public setPaymentReturnDate(string $payment_return_date) : $this
Parameters
$payment_return_date : string

The date on which the ACH returns is received by EBPP.

Return values
$this —

setPaymentScheduleType()

Sets payment_schedule_type

public setPaymentScheduleType(string $payment_schedule_type) : $this
Parameters
$payment_schedule_type : string

The schedule type for the payment. This defaults to one_time_payment.

Return values
$this —

setReturnCode()

Sets return_code

public setReturnCode(string $return_code) : $this
Parameters
$return_code : string

The ACH return code or the chargeback code received from Visa/Mastercard, in the event of returned payments.

Return values
$this —

setStatus()

Sets status

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

The status of the payment.

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

setToken()

Sets token

public setToken(string $token) : $this
Parameters
$token : string

The token is used to uniquely identify the payment, such as the POS token.

Return values
$this —

setUrl()

Sets url

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

This URL fetches the details of payment.

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