Documentation

PaymentAuthorization extends Base
in package

PaymentAuthorization 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
$audit_info  : AuditInfo
$auth_amount  : string
$captured_time  : string
$card_cvv_number  : string
$comments  : string
$currency_code3d  : string
$custom_fields  : mixed
$customer  : Customer
$customer_account  : CustomerAccount
$entry_time  : string
$funding_account  : FundingAccount
$http_status_code  : mixed
$id  : string
$id_authorization  : string
$id_customer  : string
$invocation_context  : InvocationContext
$live_mode  : string
$payment_auth_reference  : string
$payment_method  : string
$payment_network_response  : PaymentNetworkResponse
$status  : string
$url  : string
__construct()  : mixed
PaymentAuthorization constructor.
__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
cancel()  : PaymentAuthorization
cancel
cancelledBy()  : PaymentAuthorization
cancelledBy
create()  : PaymentAuthorization
create
createdBy()  : PaymentAuthorization
createdBy
forClient()  : mixed
forCustomer()  : mixed
fromAccount()  : mixed
getApiEndPoint()  : string
getAuditInfo()  : AuditInfo
Gets audit_info
getAuthAmount()  : string
Gets auth_amount
getCapturedTime()  : string
Gets captured_time
getCardCvvNumber()  : string
Gets card_cvv_number
getComments()  : string
Gets comments
getCurrencyCode3d()  : string
Gets currency_code3d
getCustomer()  : Customer
Gets customer
getCustomerAccount()  : CustomerAccount
Gets customer_account
getCustomFields()  : mixed
Gets custom_fields
getEntryTime()  : string
Gets entry_time
getFundingAccount()  : FundingAccount
Gets funding_account
getHttpStatusCode()  : mixed
getId()  : string
Gets id
getIdAuthorization()  : string
Gets id_authorization
getIdCustomer()  : string
Gets id_customer
getInvocationContext()  : InvocationContext
getPaymentAuthReference()  : string
Gets payment_auth_reference
getPaymentMethod()  : string
Gets payment_method
getPaymentNetworkResponse()  : PaymentNetworkResponse
Gets payment_network_response
getStatus()  : string
Gets status
getters()  : array<string|int, mixed>
Array of attributes to getter functions (for serialization of requests)
getUrl()  : string
Gets url
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
toAccount()  : mixed
videChannel()  : mixed
withContext()  : mixed
withCustomFields()  : mixed
withDetails()  : mixed
withMemo()  : mixed
withReference()  : mixed
requestedBy()  : mixed
setAPIEndpoint()  : mixed

Constants

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 = ['payment_auth_reference' => 'payment_auth_reference', 'id' => 'id', 'url' => 'url', 'auth_amount' => 'auth_amount', 'status' => 'status', 'payment_method' => 'payment_method', 'currency_code3d' => 'currency_code3d', 'card_cvv_number' => 'card_cvv_number', 'entry_time' => 'entry_time', 'captured_time' => 'captured_time', 'comments' => 'comments', 'custom_fields' => 'custom_fields', 'customer' => 'customer', 'funding_account' => 'funding_account', 'customer_account' => 'customer_account', 'payment_network_response' => 'payment_network_response', 'audit_info' => 'audit_info', 'id_customer' => 'ID_CUSTOMER', 'id_authorization' => 'ID_AUTHORIZATION']

$getters

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

protected static array<string|int, string> $getters = ['payment_auth_reference' => 'getPaymentAuthReference', 'id' => 'getId', 'url' => 'getUrl', 'auth_amount' => 'getAuthAmount', 'status' => 'getStatus', 'payment_method' => 'getPaymentMethod', 'currency_code3d' => 'getCurrencyCode3d', 'card_cvv_number' => 'getCardCvvNumber', 'entry_time' => 'getEntryTime', 'captured_time' => 'getCapturedTime', 'comments' => 'getComments', 'custom_fields' => 'getCustomFields', 'customer' => 'getCustomer', 'funding_account' => 'getFundingAccount', 'customer_account' => 'getCustomerAccount', 'payment_network_response' => 'getPaymentNetworkResponse', 'audit_info' => 'getAuditInfo', 'id_customer' => 'getIdCustomer', 'id_authorization' => 'getIdAuthorization']

$setters

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

protected static array<string|int, string> $setters = ['payment_auth_reference' => 'setPaymentAuthReference', 'id' => 'setId', 'url' => 'setUrl', 'auth_amount' => 'setAuthAmount', 'status' => 'setStatus', 'payment_method' => 'setPaymentMethod', 'currency_code3d' => 'setCurrencyCode3d', 'card_cvv_number' => 'setCardCvvNumber', 'entry_time' => 'setEntryTime', 'captured_time' => 'setCapturedTime', 'comments' => 'setComments', 'custom_fields' => 'setCustomFields', 'customer' => 'setCustomer', 'funding_account' => 'setFundingAccount', 'customer_account' => 'setCustomerAccount', 'payment_network_response' => 'setPaymentNetworkResponse', 'audit_info' => 'setAuditInfo', 'id_customer' => 'setIdCustomer', 'id_authorization' => 'setIdAuthorization']

$swaggerFormats

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

protected static array<string|int, string> $swaggerFormats = ['payment_auth_reference' => null, 'id' => null, 'url' => null, 'auth_amount' => null, 'status' => null, 'payment_method' => null, 'currency_code3d' => null, 'card_cvv_number' => null, 'entry_time' => null, 'captured_time' => null, 'comments' => null, 'custom_fields' => null, 'customer' => null, 'funding_account' => null, 'customer_account' => null, 'payment_network_response' => null, 'audit_info' => null, 'id_customer' => null, 'id_authorization' => null]

$swaggerTypes

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

protected static array<string|int, string> $swaggerTypes = ['payment_auth_reference' => 'string', 'id' => 'string', 'url' => 'string', 'auth_amount' => 'string', 'status' => 'string', 'payment_method' => 'string', 'currency_code3d' => 'string', 'card_cvv_number' => 'string', 'entry_time' => 'string', 'captured_time' => 'string', 'comments' => 'string', 'custom_fields' => 'map[string,string]', 'customer' => '\Orbipay\PaymentsApi\Client\Wrappers\Customer', 'funding_account' => '\Orbipay\PaymentsApi\Client\Wrappers\FundingAccount', 'customer_account' => '\Orbipay\PaymentsApi\Client\Wrappers\CustomerAccount', 'payment_network_response' => '\Orbipay\PaymentsApi\Client\Wrappers\PaymentNetworkResponse', 'audit_info' => '\Orbipay\PaymentsApi\Client\Wrappers\AuditInfo', 'id_customer' => 'string', 'id_authorization' => 'string']

$http_status_code

private mixed $http_status_code

$live_mode

private string $live_mode

Methods

__construct()

PaymentAuthorization constructor.

public __construct([string $id_authorization = null ]) : mixed
Parameters
$id_authorization : string = null
Return values
mixed —

__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 $id_customer = null ]) : mixed
Parameters
$id_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 —

getAuthAmount()

Gets auth_amount

public getAuthAmount() : string
Return values
string —

$auth_amount The amount being authorized.

getCapturedTime()

Gets captured_time

public getCapturedTime() : string
Return values
string —

$captured_time The date on which the payment authorization is captured in UTC timestamp, with ISO8601 format. For e.g., 2019-08-13T09:21:34.359+0000..

getCardCvvNumber()

Gets card_cvv_number

public getCardCvvNumber() : string
Return values
string —

$card_cvv_number This is never returned by EBPP. This needs to be passed to EBPP when making or editing a payment with a card funding account.

getComments()

Gets comments

public getComments() : string
Return values
string —

$comments Comments that can be used to recollect the operation performed on the resource object. API clients need to ensure that no sensitive information is passed in the memo. Alacriti (EBPP) is not responsible for the security of any sensitive information that may be passed as part of the memo.

getCurrencyCode3d()

Gets currency_code3d

public getCurrencyCode3d() : string
Return values
string —

$currency_code3d The three-letter currency code in the ISO4217 format, in uppercase, for the card account. It must be a currency supported by EBPP. This defaults to USD.

getCustomFields()

Gets custom_fields

public getCustomFields() : mixed
Return values
mixed —

getEntryTime()

Gets entry_time

public getEntryTime() : string
Return values
string —

$entry_time The date on which the payment authorization created in UTC timestamp, with ISO8601 format. For e.g., 2019-08-13T09:21:34.359+0000.

getHttpStatusCode()

public getHttpStatusCode() : mixed
Return values
mixed —

getId()

Gets id

public getId() : string
Return values
string —

$id The unique identifier assigned by EBPP to the payment authorization.

getIdAuthorization()

Gets id_authorization

public getIdAuthorization() : string
Return values
string —

$id_authorization The unique identifier assigned by EBPP to the payment authorization.

getIdCustomer()

Gets id_customer

public getIdCustomer() : string
Return values
string —

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

getPaymentAuthReference()

Gets payment_auth_reference

public getPaymentAuthReference() : string
Return values
string —

$payment_auth_reference The unique identifier in the client system for the payment.

getPaymentMethod()

Gets payment_method

public getPaymentMethod() : string
Return values
string —

$payment_method The fulfillment method for the payment authorization.

getStatus()

Gets status

public getStatus() : string
Return values
string —

$status The status of the payment.

getters()

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

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

getUrl()

Gets url

public getUrl() : string
Return values
string —

$url This URL fetches the details of payment authorization.

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 —

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 —

withCustomFields()

public withCustomFields([mixed $custom_fields = null ]) : mixed
Parameters
$custom_fields : mixed = null
Return values
mixed —

withDetails()

public withDetails([mixed $auth_amount = null ][, mixed $card_cvv_number = null ]) : mixed
Parameters
$auth_amount : mixed = null
$card_cvv_number : mixed = null
Return values
mixed —

withMemo()

public withMemo([mixed $comments = null ]) : mixed
Parameters
$comments : mixed = null
Return values
mixed —

withReference()

public withReference([mixed $payment_auth_reference = null ]) : mixed
Parameters
$payment_auth_reference : 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