Documentation

UpdatePaymentRequest
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_DISCOUNTED_AMOUNT  = 'discounted_amount'
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_PENALTY_AMOUNT  = 'penalty_amount'
PAYMENT_AMOUNT_TYPE_STATEMENT_BALANCE  = 'statement_balance'
$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
getCardCvvNumber()  : string
Gets card_cvv_number
getComments()  : string
Gets comments
getCustomFields()  : mixed
Gets custom_fields
getFee()  : FeeRequest
Gets fee
getFundingAccount()  : UpdatePaymentFundingAccountMinimalRequest
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
getPaymentRequestDate()  : string
Gets payment_request_date
getters()  : array<string|int, mixed>
Array of attributes to getter functions (for serialization of requests)
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
setCardCvvNumber()  : $this
Sets card_cvv_number
setComments()  : $this
Sets comments
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
setPaymentRequestDate()  : $this
Sets payment_request_date
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

Constants

PAYMENT_AMOUNT_TYPE_CURRENT_BALANCE

public mixed PAYMENT_AMOUNT_TYPE_CURRENT_BALANCE = 'current_balance'

PAYMENT_AMOUNT_TYPE_DISCOUNTED_AMOUNT

public mixed PAYMENT_AMOUNT_TYPE_DISCOUNTED_AMOUNT = 'discounted_amount'

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_PENALTY_AMOUNT

public mixed PAYMENT_AMOUNT_TYPE_PENALTY_AMOUNT = 'penalty_amount'

PAYMENT_AMOUNT_TYPE_STATEMENT_BALANCE

public mixed PAYMENT_AMOUNT_TYPE_STATEMENT_BALANCE = 'statement_balance'

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 = ['comments' => 'comments', 'custom_fields' => 'custom_fields', 'fee' => 'fee', 'amount' => 'amount', 'card_cvv_number' => 'card_cvv_number', 'payment_date' => 'payment_date', 'payment_request_date' => 'payment_request_date', 'payment_amount_type' => 'payment_amount_type', 'funding_account' => 'funding_account']

$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 = ['comments' => 'getComments', 'custom_fields' => 'getCustomFields', 'fee' => 'getFee', 'amount' => 'getAmount', 'card_cvv_number' => 'getCardCvvNumber', 'payment_date' => 'getPaymentDate', 'payment_request_date' => 'getPaymentRequestDate', 'payment_amount_type' => 'getPaymentAmountType', 'funding_account' => 'getFundingAccount']

$setters

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

protected static array<string|int, string> $setters = ['comments' => 'setComments', 'custom_fields' => 'setCustomFields', 'fee' => 'setFee', 'amount' => 'setAmount', 'card_cvv_number' => 'setCardCvvNumber', 'payment_date' => 'setPaymentDate', 'payment_request_date' => 'setPaymentRequestDate', 'payment_amount_type' => 'setPaymentAmountType', 'funding_account' => 'setFundingAccount']

$swaggerFormats

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

protected static array<string|int, string> $swaggerFormats = ['comments' => null, 'custom_fields' => null, 'fee' => null, 'amount' => null, 'card_cvv_number' => null, 'payment_date' => null, 'payment_request_date' => null, 'payment_amount_type' => null, 'funding_account' => null]

$swaggerModelName

The original name of the model.

protected static string $swaggerModelName = 'UpdatePaymentRequest'

$swaggerTypes

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

protected static array<string|int, string> $swaggerTypes = ['comments' => 'string', 'custom_fields' => 'map[string,string]', 'fee' => '\Orbipay\PaymentsApi\Client\Model\FeeRequest', 'amount' => 'string', 'card_cvv_number' => 'string', 'payment_date' => 'string', 'payment_request_date' => 'string', 'payment_amount_type' => 'string', 'funding_account' => '\Orbipay\PaymentsApi\Client\Model\UpdatePaymentFundingAccountMinimalRequest']

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

getCardCvvNumber()

Gets card_cvv_number

public getCardCvvNumber() : string
Return values
string —

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 —

getPaymentRequestDate()

Gets payment_request_date

public getPaymentRequestDate() : 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 'discounted_amount', 'penalty_amount' or 'other', the amount needs to be specified. In other cases, this is derived from the payment_amount_type.

Return values
$this —

setCardCvvNumber()

Sets card_cvv_number

public setCardCvvNumber(string $card_cvv_number) : $this
Parameters
$card_cvv_number : string

This is never returned by EBPP. This needs to be passed to EBPP when making or editing a payment with a card funding 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 —

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 —

setPaymentRequestDate()

Sets payment_request_date

public setPaymentRequestDate(string $payment_request_date) : $this
Parameters
$payment_request_date : string

The date on which the biller wants the payment to be settled. It must be in ISO8601 full-date format, namely, YYYY-MM-DD. This is applicable only if the client has opted for it.

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

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