Documentation

RecordPaymentRequest
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_STATEMENT_BALANCE  = 'statement_balance'
PAYMENT_METHOD_CASH  = 'cash'
PAYMENT_METHOD_SCANNED_CHECK  = 'scanned_check'
PAYMENT_METHOD_SWIPED_CARD  = 'swiped_card'
$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
getComments()  : string
Gets comments
getCustomer()  : SimplePaymentCustomerRequest
Gets customer
getCustomerAccount()  : CreateCustomerAccountRequest
Gets customer_account
getCustomFields()  : mixed
Gets custom_fields
getFee()  : FeeRequest
Gets fee
getFundingAccount()  : RecordedPaymentFundingAccount
Gets funding_account
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
getPaymentMethod()  : string
Gets payment_method
getPaymentMethodAllowableValues()  : array<string|int, string>
Gets allowable values of the enum
getPaymentReference()  : string
Gets payment_reference
getters()  : array<string|int, mixed>
Array of attributes to getter functions (for serialization of requests)
getToken()  : string
Gets token
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
setComments()  : $this
Sets comments
setCustomer()  : $this
Sets customer
setCustomerAccount()  : $this
Sets customer_account
setCustomFields()  : $this
Sets custom_fields
setFee()  : $this
Sets fee
setFundingAccount()  : $this
Sets funding_account
setPaymentAmountType()  : $this
Sets payment_amount_type
setPaymentDate()  : $this
Sets payment_date
setPaymentMethod()  : $this
Sets payment_method
setPaymentReference()  : $this
Sets payment_reference
setters()  : array<string|int, mixed>
Array of attributes to setter functions (for deserialization of responses)
setToken()  : $this
Sets token
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_STATEMENT_BALANCE

public mixed PAYMENT_AMOUNT_TYPE_STATEMENT_BALANCE = 'statement_balance'

PAYMENT_METHOD_SCANNED_CHECK

public mixed PAYMENT_METHOD_SCANNED_CHECK = 'scanned_check'

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 = ['amount' => 'amount', 'payment_date' => 'payment_date', 'payment_amount_type' => 'payment_amount_type', 'payment_method' => 'payment_method', 'token' => 'token', 'fee' => 'fee', 'customer' => 'customer', 'funding_account' => 'funding_account', 'customer_account' => 'customer_account', 'payment_reference' => 'payment_reference', 'comments' => 'comments', 'custom_fields' => 'custom_fields']

$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 = ['amount' => 'getAmount', 'payment_date' => 'getPaymentDate', 'payment_amount_type' => 'getPaymentAmountType', 'payment_method' => 'getPaymentMethod', 'token' => 'getToken', 'fee' => 'getFee', 'customer' => 'getCustomer', 'funding_account' => 'getFundingAccount', 'customer_account' => 'getCustomerAccount', 'payment_reference' => 'getPaymentReference', 'comments' => 'getComments', 'custom_fields' => 'getCustomFields']

$setters

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

protected static array<string|int, string> $setters = ['amount' => 'setAmount', 'payment_date' => 'setPaymentDate', 'payment_amount_type' => 'setPaymentAmountType', 'payment_method' => 'setPaymentMethod', 'token' => 'setToken', 'fee' => 'setFee', 'customer' => 'setCustomer', 'funding_account' => 'setFundingAccount', 'customer_account' => 'setCustomerAccount', 'payment_reference' => 'setPaymentReference', 'comments' => 'setComments', 'custom_fields' => 'setCustomFields']

$swaggerFormats

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

protected static array<string|int, string> $swaggerFormats = ['amount' => null, 'payment_date' => null, 'payment_amount_type' => null, 'payment_method' => null, 'token' => null, 'fee' => null, 'customer' => null, 'funding_account' => null, 'customer_account' => null, 'payment_reference' => null, 'comments' => null, 'custom_fields' => null]

$swaggerModelName

The original name of the model.

protected static string $swaggerModelName = 'RecordPaymentRequest'

$swaggerTypes

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

protected static array<string|int, string> $swaggerTypes = ['amount' => 'string', 'payment_date' => 'string', 'payment_amount_type' => 'string', 'payment_method' => 'string', 'token' => 'string', 'fee' => '\Orbipay\PaymentsApi\Client\Model\FeeRequest', 'customer' => '\Orbipay\PaymentsApi\Client\Model\SimplePaymentCustomerRequest', 'funding_account' => '\Orbipay\PaymentsApi\Client\Model\RecordedPaymentFundingAccount', 'customer_account' => '\Orbipay\PaymentsApi\Client\Model\CreateCustomerAccountRequest', 'payment_reference' => 'string', 'comments' => 'string', 'custom_fields' => 'map[string,string]']

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

getCustomFields()

Gets custom_fields

public getCustomFields() : mixed
Return values
mixed —

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

getPaymentDate()

Gets payment_date

public getPaymentDate() : string
Return values
string —

getPaymentMethod()

Gets payment_method

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

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

Return values
$this —

setCustomFields()

Sets custom_fields

public setCustomFields(mixed $custom_fields) : $this
Parameters
$custom_fields : mixed
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 —

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 —

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 —

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