Documentation

PaymentScheduleVo
in package
implements ModelInterface, ArrayAccess

Warning:

This class subject to change without prior notice, Please dont use this class directly.

Tags
category

Class

description

The schedule for the payments that are created as part of a payment setup like recurring payment or autopay.

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'
PAYMENT_RECURRING_TYPE_ANNUAL  = 'annual'
PAYMENT_RECURRING_TYPE_BI_WEEKLY  = 'bi_weekly'
PAYMENT_RECURRING_TYPE_DAILY  = 'daily'
PAYMENT_RECURRING_TYPE_HALF_YEARLY  = 'half_yearly'
PAYMENT_RECURRING_TYPE_MONTHLY  = 'monthly'
PAYMENT_RECURRING_TYPE_QUARTERLY  = 'quarterly'
PAYMENT_RECURRING_TYPE_SEMI_MONTHLY  = 'semi_monthly'
PAYMENT_RECURRING_TYPE_WEEKLY  = 'weekly'
$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
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
getPaymentDeferDays()  : string
Gets payment_defer_days
getPaymentEndDate()  : string
Gets payment_end_date
getPaymentLimitAmount()  : string
Gets payment_limit_amount
getPaymentPlanId()  : string
Gets payment_plan_id
getPaymentRecurringCount()  : string
Gets payment_recurring_count
getPaymentRecurringType()  : string
Gets payment_recurring_type
getPaymentRecurringTypeAllowableValues()  : array<string|int, string>
Gets allowable values of the enum
getPaymentStartDate()  : string
Gets payment_start_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.
setPaymentAmountType()  : $this
Sets payment_amount_type
setPaymentDeferDays()  : $this
Sets payment_defer_days
setPaymentEndDate()  : $this
Sets payment_end_date
setPaymentLimitAmount()  : $this
Sets payment_limit_amount
setPaymentPlanId()  : $this
Sets payment_plan_id
setPaymentRecurringCount()  : $this
Sets payment_recurring_count
setPaymentRecurringType()  : $this
Sets payment_recurring_type
setPaymentStartDate()  : $this
Sets payment_start_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'

PAYMENT_RECURRING_TYPE_ANNUAL

public mixed PAYMENT_RECURRING_TYPE_ANNUAL = 'annual'

PAYMENT_RECURRING_TYPE_BI_WEEKLY

public mixed PAYMENT_RECURRING_TYPE_BI_WEEKLY = 'bi_weekly'

PAYMENT_RECURRING_TYPE_DAILY

public mixed PAYMENT_RECURRING_TYPE_DAILY = 'daily'

PAYMENT_RECURRING_TYPE_HALF_YEARLY

public mixed PAYMENT_RECURRING_TYPE_HALF_YEARLY = 'half_yearly'

PAYMENT_RECURRING_TYPE_MONTHLY

public mixed PAYMENT_RECURRING_TYPE_MONTHLY = 'monthly'

PAYMENT_RECURRING_TYPE_QUARTERLY

public mixed PAYMENT_RECURRING_TYPE_QUARTERLY = 'quarterly'

PAYMENT_RECURRING_TYPE_SEMI_MONTHLY

public mixed PAYMENT_RECURRING_TYPE_SEMI_MONTHLY = 'semi_monthly'

PAYMENT_RECURRING_TYPE_WEEKLY

public mixed PAYMENT_RECURRING_TYPE_WEEKLY = 'weekly'

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 = ['payment_recurring_type' => 'payment_recurring_type', 'payment_recurring_count' => 'payment_recurring_count', 'payment_amount_type' => 'payment_amount_type', 'payment_start_date' => 'payment_start_date', 'payment_end_date' => 'payment_end_date', 'payment_limit_amount' => 'payment_limit_amount', 'payment_plan_id' => 'payment_plan_id', 'payment_defer_days' => 'payment_defer_days']

$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 = ['payment_recurring_type' => 'getPaymentRecurringType', 'payment_recurring_count' => 'getPaymentRecurringCount', 'payment_amount_type' => 'getPaymentAmountType', 'payment_start_date' => 'getPaymentStartDate', 'payment_end_date' => 'getPaymentEndDate', 'payment_limit_amount' => 'getPaymentLimitAmount', 'payment_plan_id' => 'getPaymentPlanId', 'payment_defer_days' => 'getPaymentDeferDays']

$setters

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

protected static array<string|int, string> $setters = ['payment_recurring_type' => 'setPaymentRecurringType', 'payment_recurring_count' => 'setPaymentRecurringCount', 'payment_amount_type' => 'setPaymentAmountType', 'payment_start_date' => 'setPaymentStartDate', 'payment_end_date' => 'setPaymentEndDate', 'payment_limit_amount' => 'setPaymentLimitAmount', 'payment_plan_id' => 'setPaymentPlanId', 'payment_defer_days' => 'setPaymentDeferDays']

$swaggerFormats

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

protected static array<string|int, string> $swaggerFormats = ['payment_recurring_type' => null, 'payment_recurring_count' => null, 'payment_amount_type' => null, 'payment_start_date' => null, 'payment_end_date' => null, 'payment_limit_amount' => null, 'payment_plan_id' => null, 'payment_defer_days' => null]

$swaggerModelName

The original name of the model.

protected static string $swaggerModelName = 'PaymentScheduleVo'

$swaggerTypes

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

protected static array<string|int, string> $swaggerTypes = ['payment_recurring_type' => 'string', 'payment_recurring_count' => 'string', 'payment_amount_type' => 'string', 'payment_start_date' => 'string', 'payment_end_date' => 'string', 'payment_limit_amount' => 'string', 'payment_plan_id' => 'string', 'payment_defer_days' => '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> —

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

getPaymentDeferDays()

Gets payment_defer_days

public getPaymentDeferDays() : string
Return values
string —

getPaymentEndDate()

Gets payment_end_date

public getPaymentEndDate() : string
Return values
string —

getPaymentLimitAmount()

Gets payment_limit_amount

public getPaymentLimitAmount() : string
Return values
string —

getPaymentPlanId()

Gets payment_plan_id

public getPaymentPlanId() : string
Return values
string —

getPaymentRecurringCount()

Gets payment_recurring_count

public getPaymentRecurringCount() : string
Return values
string —

getPaymentRecurringType()

Gets payment_recurring_type

public getPaymentRecurringType() : string
Return values
string —

getPaymentRecurringTypeAllowableValues()

Gets allowable values of the enum

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

getPaymentStartDate()

Gets payment_start_date

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

setPaymentAmountType()

Sets payment_amount_type

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

The amount type that is used to set the amount for payments created as part of a recurring payment or autopay setup. In the case of a recurring payment setup, the payment amount can be specified by the customer. In that case, the payment_amount_type should not be sent as it would default to 'other'. In the case of an autopay setup, the payment amount type is mandatory and it cannot be specified as 'other'. In this case, the payment amount should not be sent.

Return values
$this —

setPaymentDeferDays()

Sets payment_defer_days

public setPaymentDeferDays(string $payment_defer_days) : $this
Parameters
$payment_defer_days : string

The number of days from the bill due date that the customer wishes to delay the autopay payment by. By default an autopay payment is drafted on the bill due date.

Return values
$this —

setPaymentEndDate()

Sets payment_end_date

public setPaymentEndDate(string $payment_end_date) : $this
Parameters
$payment_end_date : string

The date by which the last payment will be drafted as part of a recurring payment setup. This is to be specified in the ISO8601 full-date format, namely, YYYY-MM-DD. This cannot be specified for autopay setups.

Return values
$this —

setPaymentLimitAmount()

Sets payment_limit_amount

public setPaymentLimitAmount(string $payment_limit_amount) : $this
Parameters
$payment_limit_amount : string

The upper limit for the payment amount in the case of recurring or autopay payments. Any amount above the limit will not be paid automatically as part of recurring payments and autopay.

Return values
$this —

setPaymentPlanId()

Sets payment_plan_id

public setPaymentPlanId(string $payment_plan_id) : $this
Parameters
$payment_plan_id : string

The reference to the payment plan, offered by the biller, that is used to set up the recurring payment. The list of payment plans offered is published as part of the biller set-up.

Return values
$this —

setPaymentRecurringCount()

Sets payment_recurring_count

public setPaymentRecurringCount(string $payment_recurring_count) : $this
Parameters
$payment_recurring_count : string

The maximum number of payments that can be created as part of a recurring payment setup. This cannot be specified for autopay setups.

Return values
$this —

setPaymentRecurringType()

Sets payment_recurring_type

public setPaymentRecurringType(string $payment_recurring_type) : $this
Parameters
$payment_recurring_type : string

The frequency of the payments created as part of a payment setup. This is applicable only for recurring payment setup, in which case it is mandatory.

Return values
$this —

setPaymentStartDate()

Sets payment_start_date

public setPaymentStartDate(string $payment_start_date) : $this
Parameters
$payment_start_date : string

The date on which the first payment will be drafted as part of a recurring payment setup. This is to be specified in the ISO8601 full-date format, namely, YYYY-MM-DD. This is mandatory for recurring payment setup. This cannot be specified for autopay setups.

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