Documentation

Contact extends Base
in package

Contact 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
$http_status_code  : mixed
$invocation_context  : InvocationContext
$live_mode  : string
$status  : string
$type  : string
$value  : string
$verification_code  : string
$verified_by  : 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
getApiEndPoint()  : string
getHttpStatusCode()  : mixed
getInvocationContext()  : InvocationContext
getStatus()  : string
Gets status
getters()  : array<string|int, mixed>
Array of attributes to getter functions (for serialization of requests)
getType()  : string
Gets type
getValue()  : string
Gets value
getVerificationCode()  : string
Gets verification_code
getVerifiedBy()  : string
Gets verified_by
isVerifiedBy()  : mixed
jsonSerialize()  : mixed
Specify data which should be serialized to JSON
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
withContactDetails()  : mixed
withContext()  : mixed
withStatus()  : mixed
withVerificationCode()  : mixed
forClient()  : mixed
requestedBy()  : mixed
setAPIEndpoint()  : mixed
videChannel()  : 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 = ['value' => 'value', 'type' => 'type', 'verified_by' => 'verified_by', 'status' => 'status', 'verification_code' => 'verification_code']

$getters

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

protected static array<string|int, string> $getters = ['value' => 'getValue', 'type' => 'getType', 'verified_by' => 'getVerifiedBy', 'status' => 'getStatus', 'verification_code' => 'getVerificationCode']

$setters

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

protected static array<string|int, string> $setters = ['value' => 'setValue', 'type' => 'setType', 'verified_by' => 'setVerifiedBy', 'status' => 'setStatus', 'verification_code' => 'setVerificationCode']

$swaggerFormats

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

protected static array<string|int, string> $swaggerFormats = ['value' => null, 'type' => null, 'verified_by' => null, 'status' => null, 'verification_code' => null]

$swaggerTypes

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

protected static array<string|int, string> $swaggerTypes = ['value' => 'string', 'type' => 'string', 'verified_by' => 'string', 'status' => 'string', 'verification_code' => 'string']

$http_status_code

private mixed $http_status_code

$live_mode

private string $live_mode

$verification_code

private string $verification_code

$verified_by

private string $verified_by

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

getApiEndPoint()

public getApiEndPoint() : string
Return values
string —

getHttpStatusCode()

public getHttpStatusCode() : mixed
Return values
mixed —

getStatus()

Gets status

public getStatus() : string
Return values
string —

$status The status of the customer's contact in EBPP.

getters()

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

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

getType()

Gets type

public getType() : string
Return values
string —

$type The type of contact that is being used.

getValue()

Gets value

public getValue() : string
Return values
string —

$value The contact value that the customer used to enroll in our EBPP system for PBT.

getVerificationCode()

Gets verification_code

public getVerificationCode() : string
Return values
string —

$verification_code The unique verification code generated by EBPP using <a href="#operation/initiateContactVerification"> Initiate Contact Verification API. This field is mandatory if the verified_by type is orbipay, indicating that the contact has been verified by the EBPP. If the verified_by type is other or none, this field may be left empty or null.

getVerifiedBy()

Gets verified_by

public getVerifiedBy() : string
Return values
string —

$verified_by The entity that verified the contact. The "orbipay" value indicates that the contact has been verified by the EBPP, which is a reliable and trusted method of contact verification. The "other" value indicates that the contact has been verified by client or some other trusted third-party. While this method may also be reliable, it is not as widely recognized or trusted as EBPP.

isVerifiedBy()

public isVerifiedBy([mixed $verified_by = null ]) : mixed
Parameters
$verified_by : mixed = null
Return values
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> —

withContactDetails()

public withContactDetails([mixed $type = null ][, mixed $value = null ]) : mixed
Parameters
$type : mixed = null
$value : 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 —

withStatus()

public withStatus([mixed $status = null ]) : mixed
Parameters
$status : mixed = null
Return values
mixed —

withVerificationCode()

public withVerificationCode([mixed $verification_code = null ]) : mixed
Parameters
$verification_code : mixed = null
Return values
mixed —

forClient()

protected forClient(mixed $client_key) : mixed
Parameters
$client_key : mixed
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 —

videChannel()

protected videChannel(mixed $channel) : mixed
Parameters
$channel : mixed
Return values
mixed —

Search results