Documentation

ResourceAudit

ResourceAudit Class Doc Comment

Tags
category

Class

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
$channel  : string
$requestor  : string
$requestor_type  : string
$timestamp  : string
attributeMap()  : array<string|int, mixed>
Array of attributes where the key is the local name, and the value is the original name
getChannel()  : string
Gets channel
getRequestor()  : string
Gets requestor
getRequestorType()  : string
Gets requestor_type
getters()  : array<string|int, mixed>
Array of attributes to getter functions (for serialization of requests)
getTimestamp()  : string
Gets timestamp
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

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 = ['channel' => 'channel', 'requestor_type' => 'requestor_type', 'requestor' => 'requestor', 'timestamp' => 'timestamp']

$getters

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

protected static array<string|int, string> $getters = ['channel' => 'getChannel', 'requestor_type' => 'getRequestorType', 'requestor' => 'getRequestor', 'timestamp' => 'getTimestamp']

$setters

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

protected static array<string|int, string> $setters = ['channel' => 'setChannel', 'requestor_type' => 'setRequestorType', 'requestor' => 'setRequestor', 'timestamp' => 'setTimestamp']

$swaggerFormats

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

protected static array<string|int, string> $swaggerFormats = ['channel' => null, 'requestor_type' => null, 'requestor' => null, 'timestamp' => null]

$swaggerTypes

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

protected static array<string|int, string> $swaggerTypes = ['channel' => 'string', 'requestor_type' => 'string', 'requestor' => 'string', 'timestamp' => 'string']

Methods

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>

getChannel()

Gets channel

public getChannel() : string
Return values
string

$channel The channel through which the API is invoked. Please contact <a href = "mailto: support@billerpayments.com">support@billerpayments.com to configure channels.

getRequestor()

Gets requestor

public getRequestor() : string
Return values
string

$requestor The identifier for the requestor of the API, in EBPP. The value to be passed in the requestor field would depend on the requestor_type.
If the requestor_type is "customer", the requestor should be the EBPP generated customer id. In the case of self registration, where there is no EBPP generated customer id yet, the requestor should be set to 'guest'.
If the requestor_type is "external_user", the requestor can be any unique identifier that the client may have for the external agent. If the requestor_type is system, requestor is optional.

getRequestorType()

Gets requestor_type

public getRequestorType() : string
Return values
string

$requestor_type If an API is being requested from an application that is being used directly by a customer, like the customer portal and IVR, the requestor_type should be set to "customer".
If an API is being requested from an application that is being used by third party agents/brokers servicing a customer on behalf of a biller/client, then the requestor_type should be set to "external_user". It should be noted that these users would not have logins for the EBPP Portal or Payment Center.

getters()

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

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

getTimestamp()

Gets timestamp

public getTimestamp() : string
Return values
string

$timestamp The UTC timestamp, in ISO8601 format, for the moment when the resource got created or modified in EBPP. For e.g., 2019-08-13T09:21:34.359+0000

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