Documentation

RecordedPayment extends Base
in package

RecordedPayment 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
$amount  : string
$audit_info  : AuditInfo
$comments  : string
$confirmation_number  : string
$currency_code3d  : string
$custom_fields  : mixed
$customer  : Customer
$customer_account  : CustomerAccount
$fee  : Fee
$funding_account  : FundingAccount
$http_status_code  : mixed
$id  : string
$id_payment  : string
$invocation_context  : InvocationContext
$live_mode  : string
$payment_amount_type  : string
$payment_date  : string
$payment_entry_date  : string
$payment_method  : string
$payment_reference  : string
$payment_return_date  : string
$payment_schedule_type  : string
$return_code  : string
$status  : string
$token  : string
$url  : string
__construct()  : mixed
RecordedPayment 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
create()  : RecordedPayment
create
createdBy()  : RecordedPayment
createdBy
delete()  : RecordedPayment
delete
deletedBy()  : RecordedPayment
deletedBy
forClient()  : mixed
fromAccount()  : mixed
get()  : RecordedPayment
get
getAmount()  : string
Gets amount
getApiEndPoint()  : string
getAuditInfo()  : AuditInfo
Gets audit_info
getComments()  : string
Gets comments
getConfirmationNumber()  : string
Gets confirmation_number
getCurrencyCode3d()  : string
Gets currency_code3d
getCustomer()  : Customer
Gets customer
getCustomerAccount()  : CustomerAccount
Gets customer_account
getCustomFields()  : mixed
Gets custom_fields
getFee()  : Fee
Gets fee
getFundingAccount()  : FundingAccount
Gets funding_account
getHttpStatusCode()  : mixed
getId()  : string
Gets id
getIdPayment()  : string
Gets id_payment
getInvocationContext()  : InvocationContext
getPaymentAmountType()  : string
Gets payment_amount_type
getPaymentDate()  : string
Gets payment_date
getPaymentEntryDate()  : string
Gets payment_entry_date
getPaymentMethod()  : string
Gets payment_method
getPaymentReference()  : string
Gets payment_reference
getPaymentReturnDate()  : string
Gets payment_return_date
getPaymentScheduleType()  : string
Gets payment_schedule_type
getReturnCode()  : string
Gets return_code
getStatus()  : string
Gets status
getters()  : array<string|int, mixed>
Array of attributes to getter functions (for serialization of requests)
getToken()  : string
Gets token
getUrl()  : string
Gets url
jsonSerialize()  : mixed
Specify data which should be serialized to JSON
retrievedBy()  : RecordedPayment
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
toAccount()  : mixed
videChannel()  : mixed
withContext()  : mixed
withCustomer()  : mixed
withCustomFields()  : mixed
withDetails()  : mixed
withFee()  : mixed
withMemo()  : mixed
withReference()  : mixed
withToken()  : 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 = ['id' => 'id', 'url' => 'url', 'fee' => 'fee', 'status' => 'status', 'payment_method' => 'payment_method', 'token' => 'token', 'confirmation_number' => 'confirmation_number', 'custom_fields' => 'custom_fields', 'currency_code3d' => 'currency_code3d', 'amount' => 'amount', 'payment_date' => 'payment_date', 'payment_schedule_type' => 'payment_schedule_type', 'payment_amount_type' => 'payment_amount_type', 'payment_reference' => 'payment_reference', 'payment_entry_date' => 'payment_entry_date', 'payment_return_date' => 'payment_return_date', 'comments' => 'comments', 'return_code' => 'return_code', 'customer' => 'customer', 'funding_account' => 'funding_account', 'customer_account' => 'customer_account', 'audit_info' => 'audit_info', 'id_payment' => 'ID_PAYMENT']

$getters

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

protected static array<string|int, string> $getters = ['id' => 'getId', 'url' => 'getUrl', 'fee' => 'getFee', 'status' => 'getStatus', 'payment_method' => 'getPaymentMethod', 'token' => 'getToken', 'confirmation_number' => 'getConfirmationNumber', 'custom_fields' => 'getCustomFields', 'currency_code3d' => 'getCurrencyCode3d', 'amount' => 'getAmount', 'payment_date' => 'getPaymentDate', 'payment_schedule_type' => 'getPaymentScheduleType', 'payment_amount_type' => 'getPaymentAmountType', 'payment_reference' => 'getPaymentReference', 'payment_entry_date' => 'getPaymentEntryDate', 'payment_return_date' => 'getPaymentReturnDate', 'comments' => 'getComments', 'return_code' => 'getReturnCode', 'customer' => 'getCustomer', 'funding_account' => 'getFundingAccount', 'customer_account' => 'getCustomerAccount', 'audit_info' => 'getAuditInfo', 'id_payment' => 'getIdPayment']

$setters

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

protected static array<string|int, string> $setters = ['id' => 'setId', 'url' => 'setUrl', 'fee' => 'setFee', 'status' => 'setStatus', 'payment_method' => 'setPaymentMethod', 'token' => 'setToken', 'confirmation_number' => 'setConfirmationNumber', 'custom_fields' => 'setCustomFields', 'currency_code3d' => 'setCurrencyCode3d', 'amount' => 'setAmount', 'payment_date' => 'setPaymentDate', 'payment_schedule_type' => 'setPaymentScheduleType', 'payment_amount_type' => 'setPaymentAmountType', 'payment_reference' => 'setPaymentReference', 'payment_entry_date' => 'setPaymentEntryDate', 'payment_return_date' => 'setPaymentReturnDate', 'comments' => 'setComments', 'return_code' => 'setReturnCode', 'customer' => 'setCustomer', 'funding_account' => 'setFundingAccount', 'customer_account' => 'setCustomerAccount', 'audit_info' => 'setAuditInfo', 'id_payment' => 'setIdPayment']

$swaggerFormats

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

protected static array<string|int, string> $swaggerFormats = ['id' => null, 'url' => null, 'fee' => null, 'status' => null, 'payment_method' => null, 'token' => null, 'confirmation_number' => null, 'custom_fields' => null, 'currency_code3d' => null, 'amount' => null, 'payment_date' => null, 'payment_schedule_type' => null, 'payment_amount_type' => null, 'payment_reference' => null, 'payment_entry_date' => null, 'payment_return_date' => null, 'comments' => null, 'return_code' => null, 'customer' => null, 'funding_account' => null, 'customer_account' => null, 'audit_info' => null, 'id_payment' => null]

$swaggerTypes

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

protected static array<string|int, string> $swaggerTypes = ['id' => 'string', 'url' => 'string', 'fee' => '\Orbipay\PaymentsApi\Client\Wrappers\Fee', 'status' => 'string', 'payment_method' => 'string', 'token' => 'string', 'confirmation_number' => 'string', 'custom_fields' => 'map[string,string]', 'currency_code3d' => 'string', 'amount' => 'string', 'payment_date' => 'string', 'payment_schedule_type' => 'string', 'payment_amount_type' => 'string', 'payment_reference' => 'string', 'payment_entry_date' => 'string', 'payment_return_date' => 'string', 'comments' => 'string', 'return_code' => 'string', 'customer' => '\Orbipay\PaymentsApi\Client\Wrappers\Customer', 'funding_account' => '\Orbipay\PaymentsApi\Client\Wrappers\FundingAccount', 'customer_account' => '\Orbipay\PaymentsApi\Client\Wrappers\CustomerAccount', 'audit_info' => '\Orbipay\PaymentsApi\Client\Wrappers\AuditInfo', 'id_payment' => 'string']

$http_status_code

private mixed $http_status_code

$live_mode

private string $live_mode

Methods

__construct()

RecordedPayment constructor.

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

fromAccount()

public fromAccount([mixed $funding_account = null ]) : mixed
Parameters
$funding_account : mixed = null
Return values
mixed —

getAmount()

Gets amount

public getAmount() : string
Return values
string —

$amount The amount being paid. In case the payment_amount_type is 'other', the amount needs to be specified. In other cases, this is derived from the payment_amount_type.

getApiEndPoint()

public getApiEndPoint() : string
Return values
string —

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.

getConfirmationNumber()

Gets confirmation_number

public getConfirmationNumber() : string
Return values
string —

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

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 —

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.

getIdPayment()

Gets id_payment

public getIdPayment() : string
Return values
string —

$id_payment The unique identifier assigned by EBPP to the payment.

getPaymentAmountType()

Gets payment_amount_type

public getPaymentAmountType() : string
Return values
string —

$payment_amount_type The type of amount, as per the bill/statement, that is being paid. The payment amount is derived from the amount type selected for the payment. This defaults to other.

getPaymentDate()

Gets payment_date

public getPaymentDate() : string
Return values
string —

$payment_date The date on which the payment is scheduled to be made. It must be in ISO8601 full-date format, namely, YYYY-MM-DD.

getPaymentEntryDate()

Gets payment_entry_date

public getPaymentEntryDate() : string
Return values
string —

$payment_entry_date The date on which the payment is captured in EBPP. It must be in ISO8601 full-date format, namely, YYYY-MM-DD.

getPaymentMethod()

Gets payment_method

public getPaymentMethod() : string
Return values
string —

$payment_method The non fulfillment method for the payment.

getPaymentReference()

Gets payment_reference

public getPaymentReference() : string
Return values
string —

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

getPaymentReturnDate()

Gets payment_return_date

public getPaymentReturnDate() : string
Return values
string —

$payment_return_date The date on which the ACH returns is received by EBPP.

getPaymentScheduleType()

Gets payment_schedule_type

public getPaymentScheduleType() : string
Return values
string —

$payment_schedule_type The schedule type for the payment. This defaults to one_time_payment.

getReturnCode()

Gets return_code

public getReturnCode() : string
Return values
string —

$return_code The ACH return code or the chargeback code received from Visa/Mastercard, in the event of returned payments.

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

getToken()

Gets token

public getToken() : string
Return values
string —

$token The token is used to uniquely identify the payment, such as the POS token.

getUrl()

Gets url

public getUrl() : string
Return values
string —

$url This URL fetches the details of payment.

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 —

withCustomer()

public withCustomer([mixed $customer = null ]) : mixed
Parameters
$customer : mixed = null
Return values
mixed —

withCustomFields()

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

withDetails()

public withDetails([mixed $payment_amount_type = null ][, mixed $amount = null ][, mixed $payment_date = null ][, mixed $payment_method = null ]) : mixed
Parameters
$payment_amount_type : mixed = null
$amount : mixed = null
$payment_date : mixed = null
$payment_method : mixed = null
Return values
mixed —

withFee()

public withFee([mixed $fee = null ]) : mixed
Parameters
$fee : mixed = null
Return values
mixed —

withMemo()

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

withReference()

public withReference([mixed $payment_reference = null ]) : mixed
Parameters
$payment_reference : mixed = null
Return values
mixed —

withToken()

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