Documentation

PaymentSchedule
in package

PaymentSchedule Class Doc Comment

Tags
category

Class

description

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

Table of Contents

DISCRIMINATOR  = null
$attributeMap  : array<string|int, string>
Array of attributes where the key is the local name, and the value is the original name
$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
$swaggerTypes  : array<string|int, string>
Array of property to type mappings. Used for (de)serialization
$payment_amount_type  : string
$payment_defer_days  : string
$payment_end_date  : string
$payment_limit_amount  : string
$payment_plan_id  : string
$payment_recurring_count  : string
$payment_recurring_type  : string
$payment_start_date  : string
__construct()  : mixed
PaymentSchedule constructor.
attributeMap()  : array<string|int, mixed>
Array of attributes where the key is the local name, and the value is the original name
getPaymentAmountType()  : string
Gets payment_amount_type
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
getPaymentStartDate()  : string
Gets payment_start_date
getters()  : array<string|int, mixed>
Array of attributes to getter functions (for serialization of requests)
jsonSerialize()  : mixed
Specify data which should be serialized to JSON
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
withPaymentLimitAmount()  : mixed

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 = ['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']

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

$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()

PaymentSchedule constructor.

public __construct([string $payment_recurring_type = null ][, string $payment_recurring_count = null ][, string $payment_amount_type = null ][, string $payment_start_date = null ][, string $payment_end_date = null ][, string $payment_limit_amount = null ][, string $payment_plan_id = null ][, string $payment_defer_days = null ]) : mixed
Parameters
$payment_recurring_type : string = null
$payment_recurring_count : string = null
$payment_amount_type : string = null
$payment_start_date : string = null
$payment_end_date : string = null
$payment_limit_amount : string = null
$payment_plan_id : string = null
$payment_defer_days : string = null
Return values
mixed —

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

getPaymentAmountType()

Gets payment_amount_type

public getPaymentAmountType() : string
Return values
string —

$payment_amount_type 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.

getPaymentDeferDays()

Gets payment_defer_days

public getPaymentDeferDays() : string
Return values
string —

$payment_defer_days 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.

getPaymentEndDate()

Gets payment_end_date

public getPaymentEndDate() : string
Return values
string —

$payment_end_date 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.

getPaymentLimitAmount()

Gets payment_limit_amount

public getPaymentLimitAmount() : string
Return values
string —

$payment_limit_amount 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.

getPaymentPlanId()

Gets payment_plan_id

public getPaymentPlanId() : string
Return values
string —

$payment_plan_id 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.

getPaymentRecurringCount()

Gets payment_recurring_count

public getPaymentRecurringCount() : string
Return values
string —

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

getPaymentRecurringType()

Gets payment_recurring_type

public getPaymentRecurringType() : string
Return values
string —

$payment_recurring_type 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.

getPaymentStartDate()

Gets payment_start_date

public getPaymentStartDate() : string
Return values
string —

$payment_start_date 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.

getters()

Array of attributes to getter functions (for serialization of requests)

public static getters() : array<string|int, mixed>
Return values
array<string|int, mixed> —

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

withPaymentLimitAmount()

public withPaymentLimitAmount([mixed $payment_limit_amount = null ]) : mixed
Parameters
$payment_limit_amount : mixed = null
Return values
mixed —

Search results