Documentation

PaymentAuthorizationResponse
in package
implements ModelInterface, ArrayAccess

Warning:

This class subject to change without prior notice, Please dont use this class directly.

Tags
category

Class

Interfaces, Classes and Traits

ModelInterface
Warning:
ArrayAccess

Table of Contents

DISCRIMINATOR  = null
PAYMENT_METHOD_VOYAGER_FLEET  = 'voyager_fleet'
STATUS_APPROVED  = 'approved'
STATUS_CANCELLED  = 'cancelled'
STATUS_DECLINED  = 'declined'
STATUS_ERROR  = 'error'
STATUS_EXPIRED  = 'expired'
STATUS_PROCESSED  = 'processed'
STATUS_REVERSED  = 'reversed'
$attributeMap  : array<string|int, string>
Array of attributes where the key is the local name, and the value is the original name
$container  : array<string|int, mixed>
Associative array for storing property values
$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
$swaggerModelName  : string
The original name of the model.
$swaggerTypes  : array<string|int, string>
Array of property to type mappings. Used for (de)serialization
__construct()  : mixed
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
getAuditInfo()  : AuditInfoVo
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()  : PaymentAuthCustomerResponse
Gets customer
getCustomerAccount()  : PaymentAuthCustomerAccountResponse
Gets customer_account
getCustomFields()  : mixed
Gets custom_fields
getEntryTime()  : string
Gets entry_time
getFundingAccount()  : PaymentAuthFundingAccountResponse
Gets funding_account
getId()  : string
Gets id
getModelName()  : string
The original name of the model.
getPaymentAuthReference()  : string
Gets payment_auth_reference
getPaymentMethod()  : string
Gets payment_method
getPaymentMethodAllowableValues()  : array<string|int, string>
Gets allowable values of the enum
getPaymentNetworkResponse()  : PaymentNetworkResponseVo
Gets payment_network_response
getStatus()  : string
Gets status
getStatusAllowableValues()  : array<string|int, string>
Gets allowable values of the enum
getters()  : array<string|int, mixed>
Array of attributes to getter functions (for serialization of requests)
getUrl()  : string
Gets url
offsetExists()  : bool
Returns true if offset exists. False otherwise.
offsetGet()  : mixed
Gets offset.
offsetSet()  : void
Sets value based on offset.
offsetUnset()  : void
Unsets offset.
setAuditInfo()  : $this
Sets audit_info
setAuthAmount()  : $this
Sets auth_amount
setCapturedTime()  : $this
Sets captured_time
setCardCvvNumber()  : $this
Sets card_cvv_number
setComments()  : $this
Sets comments
setCurrencyCode3d()  : $this
Sets currency_code3d
setCustomer()  : $this
Sets customer
setCustomerAccount()  : $this
Sets customer_account
setCustomFields()  : $this
Sets custom_fields
setEntryTime()  : $this
Sets entry_time
setFundingAccount()  : $this
Sets funding_account
setId()  : $this
Sets id
setPaymentAuthReference()  : $this
Sets payment_auth_reference
setPaymentMethod()  : $this
Sets payment_method
setPaymentNetworkResponse()  : $this
Sets payment_network_response
setStatus()  : $this
Sets status
setters()  : array<string|int, mixed>
Array of attributes to setter functions (for deserialization of responses)
setUrl()  : $this
Sets url
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 = ['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']

$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']

$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']

$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]

$swaggerModelName

The original name of the model.

protected static string $swaggerModelName = 'PaymentAuthorizationResponse'

$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\Model\PaymentAuthCustomerResponse', 'funding_account' => '\Orbipay\PaymentsApi\Client\Model\PaymentAuthFundingAccountResponse', 'customer_account' => '\Orbipay\PaymentsApi\Client\Model\PaymentAuthCustomerAccountResponse', 'payment_network_response' => '\Orbipay\PaymentsApi\Client\Model\PaymentNetworkResponseVo', 'audit_info' => '\Orbipay\PaymentsApi\Client\Model\AuditInfoVo']

Methods

__construct()

Constructor

public __construct([array<string|int, mixed> $data = null ]) : mixed
Parameters
$data : array<string|int, mixed> = null

Associated array of property values initializing the model

Return values
mixed —

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

getPaymentAuthReference()

Gets payment_auth_reference

public getPaymentAuthReference() : string
Return values
string —

getPaymentMethodAllowableValues()

Gets allowable values of the enum

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

getStatusAllowableValues()

Gets allowable values of the enum

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

getters()

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

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

offsetExists()

Returns true if offset exists. False otherwise.

public offsetExists(int $offset) : bool
Parameters
$offset : int

Offset

Return values
bool —

offsetGet()

Gets offset.

public offsetGet(int $offset) : mixed
Parameters
$offset : int

Offset

Return values
mixed —

offsetSet()

Sets value based on offset.

public offsetSet(int $offset, mixed $value) : void
Parameters
$offset : int

Offset

$value : mixed

Value to be set

Return values
void —

offsetUnset()

Unsets offset.

public offsetUnset(int $offset) : void
Parameters
$offset : int

Offset

Return values
void —

setAuthAmount()

Sets auth_amount

public setAuthAmount(string $auth_amount) : $this
Parameters
$auth_amount : string

The amount being authorized.

Return values
$this —

setCapturedTime()

Sets captured_time

public setCapturedTime(string $captured_time) : $this
Parameters
$captured_time : string

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

Return values
$this —

setCardCvvNumber()

Sets card_cvv_number

public setCardCvvNumber(string $card_cvv_number) : $this
Parameters
$card_cvv_number : string

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

Return values
$this —

setComments()

Sets comments

public setComments(string $comments) : $this
Parameters
$comments : string

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.

Return values
$this —

setCurrencyCode3d()

Sets currency_code3d

public setCurrencyCode3d(string $currency_code3d) : $this
Parameters
$currency_code3d : string

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.

Return values
$this —

setCustomFields()

Sets custom_fields

public setCustomFields(mixed $custom_fields) : $this
Parameters
$custom_fields : mixed
Return values
$this —

setEntryTime()

Sets entry_time

public setEntryTime(string $entry_time) : $this
Parameters
$entry_time : string

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

Return values
$this —

setId()

Sets id

public setId(string $id) : $this
Parameters
$id : string

The unique identifier assigned by EBPP to the payment authorization.

Return values
$this —

setPaymentAuthReference()

Sets payment_auth_reference

public setPaymentAuthReference(string $payment_auth_reference) : $this
Parameters
$payment_auth_reference : string

The unique identifier in the client system for the payment.

Return values
$this —

setPaymentMethod()

Sets payment_method

public setPaymentMethod(string $payment_method) : $this
Parameters
$payment_method : string

The fulfillment method for the payment authorization.

Return values
$this —

setStatus()

Sets status

public setStatus(string $status) : $this
Parameters
$status : string

The status of the payment.

Return values
$this —

setters()

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

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

setUrl()

Sets url

public setUrl(string $url) : $this
Parameters
$url : string

This URL fetches the details of payment authorization.

Return values
$this —

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