Documentation

PBT extends Base
in package

PBT Class Doc Comment

Tags
category

Class

Table of Contents

DISCRIMINATOR  = null
$api_end_point  : string
$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
$contact  : Contact
$customer  : Customer
$customer_account  : CustomerAccount
$days_before_due  : string
$enrollment_status  : string
$funding_account  : FundingAccount
$http_status_code  : mixed
$invocation_context  : InvocationContext
$live_mode  : string
$payment_amount_type  : string
__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
forClient()  : mixed
forCustomer()  : mixed
fromAccount()  : mixed
getApiEndPoint()  : string
getContact()  : Contact
Gets contact
getCustomer()  : Customer
Gets customer
getCustomerAccount()  : CustomerAccount
Gets customer_account
getDaysBeforeDue()  : string
Gets days_before_due
getEnrollmentStatus()  : string
Gets enrollment_status
getFundingAccount()  : FundingAccount
Gets funding_account
getHttpStatusCode()  : mixed
getInvocationContext()  : InvocationContext
getPaymentAmountType()  : string
Gets payment_amount_type
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
manage()  : PBT
manage
performedBy()  : PBT
performedBy
setInvocationContext()  : mixed
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
toAccount()  : mixed
videChannel()  : mixed
withContact()  : mixed
withContext()  : mixed
withDaysBeforeDue()  : mixed
withEnrollmentStatus()  : mixed
withPaymentAmountType()  : mixed
requestedBy()  : mixed
setAPIEndpoint()  : mixed

Constants

DISCRIMINATOR

public mixed DISCRIMINATOR = null

Properties

$api_end_point

protected string $api_end_point

$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 = ['contact' => 'contact', 'customer' => 'customer', 'funding_account' => 'funding_account', 'customer_account' => 'customer_account', 'payment_amount_type' => 'payment_amount_type', 'days_before_due' => 'days_before_due', 'enrollment_status' => 'enrollment_status']

$getters

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

protected static array<string|int, string> $getters = ['contact' => 'getContact', 'customer' => 'getCustomer', 'funding_account' => 'getFundingAccount', 'customer_account' => 'getCustomerAccount', 'payment_amount_type' => 'getPaymentAmountType', 'days_before_due' => 'getDaysBeforeDue', 'enrollment_status' => 'getEnrollmentStatus']

$setters

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

protected static array<string|int, string> $setters = ['contact' => 'setContact', 'customer' => 'setCustomer', 'funding_account' => 'setFundingAccount', 'customer_account' => 'setCustomerAccount', 'payment_amount_type' => 'setPaymentAmountType', 'days_before_due' => 'setDaysBeforeDue', 'enrollment_status' => 'setEnrollmentStatus']

$swaggerFormats

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

protected static array<string|int, string> $swaggerFormats = ['contact' => null, 'customer' => null, 'funding_account' => null, 'customer_account' => null, 'payment_amount_type' => null, 'days_before_due' => null, 'enrollment_status' => null]

$swaggerTypes

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

protected static array<string|int, string> $swaggerTypes = ['contact' => '\Orbipay\PaymentsApi\Client\Wrappers\Contact', 'customer' => '\Orbipay\PaymentsApi\Client\Wrappers\Customer', 'funding_account' => '\Orbipay\PaymentsApi\Client\Wrappers\FundingAccount', 'customer_account' => '\Orbipay\PaymentsApi\Client\Wrappers\CustomerAccount', 'payment_amount_type' => 'string', 'days_before_due' => 'string', 'enrollment_status' => 'string']

$days_before_due

private string $days_before_due

$enrollment_status

private string $enrollment_status

$http_status_code

private mixed $http_status_code

$live_mode

private string $live_mode

$payment_amount_type

private string $payment_amount_type

Methods

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

forClient()

public forClient([mixed $client_key = null ]) : mixed
Parameters
$client_key : mixed = null
Return values
mixed —

forCustomer()

public forCustomer([mixed $customer = null ]) : mixed
Parameters
$customer : mixed = null
Return values
mixed —

fromAccount()

public fromAccount([mixed $funding_account = null ]) : mixed
Parameters
$funding_account : mixed = null
Return values
mixed —

getApiEndPoint()

public getApiEndPoint() : string
Return values
string —

getContact()

Gets contact

public getContact() : Contact
Return values
Contact —

$contact contact

getCustomer()

Gets customer

public getCustomer() : Customer
Return values
Customer —

$customer customer

getDaysBeforeDue()

Gets days_before_due

public getDaysBeforeDue() : string
Return values
string —

$days_before_due The number of days before the payment due date on which the payment alert is to be sent to the enrolled customer to the contact phone provided here.

getEnrollmentStatus()

Gets enrollment_status

public getEnrollmentStatus() : string
Return values
string —

$enrollment_status The status of the payment enrolment.

getHttpStatusCode()

public getHttpStatusCode() : mixed
Return values
mixed —

getPaymentAmountType()

Gets payment_amount_type

public getPaymentAmountType() : string
Return values
string —

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

getters()

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

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

performedBy()

performedBy

public performedBy([ $requestor = null ][,  $requestor_type = null ]) : PBT
Parameters
$requestor : = null
$requestor_type : = null
Return values
PBT —

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

toAccount()

public toAccount([mixed $customer_account = null ]) : mixed
Parameters
$customer_account : mixed = null
Return values
mixed —

videChannel()

public videChannel([mixed $channel = null ]) : mixed
Parameters
$channel : mixed = null
Return values
mixed —

withContact()

public withContact([mixed $contact = null ]) : mixed
Parameters
$contact : mixed = null
Return values
mixed —

withContext()

public withContext(InvocationContext $request[, string $live_mode = null ][, string $apiEndPoint = null ]) : mixed
Parameters
$request : InvocationContext
$live_mode : string = null
$apiEndPoint : string = null
Return values
mixed —

withDaysBeforeDue()

public withDaysBeforeDue([mixed $days_before_due = null ]) : mixed
Parameters
$days_before_due : mixed = null
Return values
mixed —

withEnrollmentStatus()

public withEnrollmentStatus([mixed $enrollment_status = null ]) : mixed
Parameters
$enrollment_status : mixed = null
Return values
mixed —

withPaymentAmountType()

public withPaymentAmountType([mixed $payment_amount_type = null ]) : mixed
Parameters
$payment_amount_type : mixed = null
Return values
mixed —

requestedBy()

protected requestedBy(mixed $requestor, mixed $requestor_type) : mixed
Parameters
$requestor : mixed
$requestor_type : mixed
Return values
mixed —

setAPIEndpoint()

protected setAPIEndpoint([string $live_mode = null ][, string $apiEndPoint = null ]) : mixed
Parameters
$live_mode : string = null
$apiEndPoint : string = null
Return values
mixed —

Search results