Documentation

Payments extends Base
in package

Payments 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
$confirmation_number  : string
$from_date  : string
$from_index  : string
$has_more_results  : string
$http_status_code  : mixed
$id_customer  : string
$id_customer_account  : string
$id_funding_account  : string
$invocation_context  : InvocationContext
$list  : array<string|int, Payment>
$live_mode  : string
$page_size  : string
$payment_schedule_type  : array<string|int, string>
$query_id  : string
$status  : array<string|int, string>
$to_date  : string
$to_index  : string
$total_results_count  : string
$url  : 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
findBy()  : mixed
forClient()  : mixed
forCustomer()  : mixed
get()  : Payments
get
getApiEndPoint()  : string
getConfirmationNumber()  : string
Gets confirmation_number
getFromDate()  : string
Gets from_date
getFromIndex()  : string
Gets from_index
getHasMoreResults()  : string
Gets has_more_results
getHttpStatusCode()  : mixed
getIdCustomer()  : string
Gets id_customer
getIdCustomerAccount()  : string
Gets id_customer_account
getIdFundingAccount()  : string
Gets id_funding_account
getInvocationContext()  : InvocationContext
getList()  : array<string|int, Payment>
Gets list
getPageSize()  : string
Gets page_size
getPaymentScheduleType()  : array<string|int, string>
Gets payment_schedule_type
getQueryId()  : string
Gets query_id
getStatus()  : array<string|int, string>
Gets status
getters()  : array<string|int, mixed>
Array of attributes to getter functions (for serialization of requests)
getToDate()  : string
Gets to_date
getToIndex()  : string
Gets to_index
getTotalResultsCount()  : string
Gets total_results_count
getUrl()  : string
Gets url
jsonSerialize()  : mixed
Specify data which should be serialized to JSON
retrievedBy()  : Payments
retrievedBy
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
videChannel()  : mixed
withContext()  : 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 = ['list' => 'list', 'total_results_count' => 'total_results_count', 'has_more_results' => 'has_more_results', 'url' => 'url', 'from_index' => 'from_index', 'to_index' => 'to_index', 'query_id' => 'query_id', 'id_customer' => 'id_customer', 'id_funding_account' => 'id_funding_account', 'id_customer_account' => 'id_customer_account', 'confirmation_number' => 'confirmation_number', 'status' => 'status', 'payment_schedule_type' => 'payment_schedule_type', 'from_date' => 'from_date', 'to_date' => 'to_date', 'page_size' => 'page_size']

$getters

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

protected static array<string|int, string> $getters = ['list' => 'getList', 'total_results_count' => 'getTotalResultsCount', 'has_more_results' => 'getHasMoreResults', 'url' => 'getUrl', 'from_index' => 'getFromIndex', 'to_index' => 'getToIndex', 'query_id' => 'getQueryId', 'id_customer' => 'getIdCustomer', 'id_funding_account' => 'getIdFundingAccount', 'id_customer_account' => 'getIdCustomerAccount', 'confirmation_number' => 'getConfirmationNumber', 'status' => 'getStatus', 'payment_schedule_type' => 'getPaymentScheduleType', 'from_date' => 'getFromDate', 'to_date' => 'getToDate', 'page_size' => 'getPageSize']

$setters

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

protected static array<string|int, string> $setters = ['list' => 'setList', 'total_results_count' => 'setTotalResultsCount', 'has_more_results' => 'setHasMoreResults', 'url' => 'setUrl', 'from_index' => 'setFromIndex', 'to_index' => 'setToIndex', 'query_id' => 'setQueryId', 'id_customer' => 'setIdCustomer', 'id_funding_account' => 'setIdFundingAccount', 'id_customer_account' => 'setIdCustomerAccount', 'confirmation_number' => 'setConfirmationNumber', 'status' => 'setStatus', 'payment_schedule_type' => 'setPaymentScheduleType', 'from_date' => 'setFromDate', 'to_date' => 'setToDate', 'page_size' => 'setPageSize']

$swaggerFormats

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

protected static array<string|int, string> $swaggerFormats = ['list' => null, 'total_results_count' => null, 'has_more_results' => null, 'url' => null, 'from_index' => null, 'to_index' => null, 'query_id' => null, 'id_customer' => null, 'id_funding_account' => null, 'id_customer_account' => null, 'confirmation_number' => null, 'status' => null, 'payment_schedule_type' => null, 'from_date' => null, 'to_date' => null, 'page_size' => null]

$swaggerTypes

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

protected static array<string|int, string> $swaggerTypes = ['list' => '\Orbipay\PaymentsApi\Client\Wrappers\Payment[]', 'total_results_count' => 'string', 'has_more_results' => 'string', 'url' => 'string', 'from_index' => 'string', 'to_index' => 'string', 'query_id' => 'string', 'id_customer' => 'string', 'id_funding_account' => 'string', 'id_customer_account' => 'string', 'confirmation_number' => 'string', 'status' => 'string[]', 'payment_schedule_type' => 'string[]', 'from_date' => 'string', 'to_date' => 'string', 'page_size' => 'string']

$confirmation_number

private string $confirmation_number

$has_more_results

private string $has_more_results

$http_status_code

private mixed $http_status_code

$id_customer

private string $id_customer

$id_customer_account

private string $id_customer_account

$id_funding_account

private string $id_funding_account

$live_mode

private string $live_mode

$payment_schedule_type

private array<string|int, string> $payment_schedule_type

$status

private array<string|int, string> $status

$total_results_count

private string $total_results_count

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

findBy()

public findBy([MultiMap $filterMap = null ]) : mixed
Parameters
$filterMap : MultiMap = null
Return values
mixed —

forClient()

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

forCustomer()

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

getApiEndPoint()

public getApiEndPoint() : string
Return values
string —

getConfirmationNumber()

Gets confirmation_number

public getConfirmationNumber() : string
Return values
string —

$confirmation_number The confirmation number or reference provided to the customer for the successful payment.

getFromDate()

Gets from_date

public getFromDate() : string
Return values
string —

$from_date The date from which payments, matching the criteria specified, need to be retrieved.

getFromIndex()

Gets from_index

public getFromIndex() : string
Return values
string —

$from_index The id of the object before which the previous set of objects are to be retrieved.

getHasMoreResults()

Gets has_more_results

public getHasMoreResults() : string
Return values
string —

$has_more_results true if there are more results or pages

getHttpStatusCode()

public getHttpStatusCode() : mixed
Return values
mixed —

getIdCustomer()

Gets id_customer

public getIdCustomer() : string
Return values
string —

$id_customer The unique identifier assigned by EBPP to the customer.

getIdCustomerAccount()

Gets id_customer_account

public getIdCustomerAccount() : string
Return values
string —

$id_customer_account The unique identifier assigned by EBPP to the customer account

getIdFundingAccount()

Gets id_funding_account

public getIdFundingAccount() : string
Return values
string —

$id_funding_account The unique identifier assigned by EBPP to the funding account

getList()

Gets list

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

$list list

getPageSize()

Gets page_size

public getPageSize() : string
Return values
string —

$page_size The maximum number of objects returned in the query.

getPaymentScheduleType()

Gets payment_schedule_type

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

$payment_schedule_type The schedule type for the payment setup. This can take multiple values in the format key=value1&key=value2....

getQueryId()

Gets query_id

public getQueryId() : string
Return values
string —

$query_id The query id of the object.

getStatus()

Gets status

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

$status The status of the payment. This can take multiple values in the format key=value1&key=value2....

getters()

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

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

getToDate()

Gets to_date

public getToDate() : string
Return values
string —

$to_date The date upto which payments, matching the criteria specified, need to be retrieved.

getToIndex()

Gets to_index

public getToIndex() : string
Return values
string —

$to_index The id of the object after which the next set of objects are to be retrieved.

getTotalResultsCount()

Gets total_results_count

public getTotalResultsCount() : string
Return values
string —

$total_results_count total number of payments available with matching criteria

getUrl()

Gets url

public getUrl() : string
Return values
string —

$url This URL fetches the next or previous set of payments, based on the presence of after_object or before_object parameter.

retrievedBy()

retrievedBy

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

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

videChannel()

public videChannel([mixed $channel = null ]) : mixed
Parameters
$channel : 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 —

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