Documentation

SimplePayment extends Base
in package

SimplePayment 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
$card_cvv_number  : string
$comments  : string
$confirmation_number  : string
$currency_code3d  : string
$custom_fields  : mixed
$customer  : Customer
$customer_account  : CustomerAccount
$expected_payment_settlement_date  : string
$fee  : Fee
$funding_account  : FundingAccount
$http_status_code  : mixed
$id  : string
$invocation_context  : InvocationContext
$live_mode  : string
$payment_amount_type  : string
$payment_date  : string
$payment_entry_date  : string
$payment_method  : string
$payment_network_response  : PaymentNetworkResponse
$payment_notification_email  : string
$payment_reference  : string
$payment_request_date  : string
$payment_return_date  : string
$payment_schedule_type  : string
$return_code  : string
$save_funding_account  : string
$status  : string
$url  : 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
create()  : SimplePayment
create
createdBy()  : SimplePayment
createdBy
forClient()  : mixed
forCustomer()  : mixed
fromAccount()  : mixed
getAmount()  : string
Gets amount
getApiEndPoint()  : string
getAuditInfo()  : AuditInfo
Gets audit_info
getCardCvvNumber()  : string
Gets card_cvv_number
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
getExpectedPaymentSettlementDate()  : string
Gets expected_payment_settlement_date
getFee()  : Fee
Gets fee
getFundingAccount()  : FundingAccount
Gets funding_account
getHttpStatusCode()  : mixed
getId()  : string
Gets id
getInvocationContext()  : InvocationContext
getPaymentAmountType()  : string
Gets payment_amount_type
getPaymentDate()  : string
Gets payment_date
getPaymentEntryDate()  : string
Gets payment_entry_date
getPaymentMethod()  : string
Gets payment_method
getPaymentNetworkResponse()  : PaymentNetworkResponse
Gets payment_network_response
getPaymentNotificationEmail()  : string
Gets payment_notification_email
getPaymentReference()  : string
Gets payment_reference
getPaymentRequestDate()  : string
Gets payment_request_date
getPaymentReturnDate()  : string
Gets payment_return_date
getPaymentScheduleType()  : string
Gets payment_schedule_type
getReturnCode()  : string
Gets return_code
getSaveFundingAccount()  : string
Gets save_funding_account
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
withFee()  : mixed
withMemo()  : mixed
withPaymentNotificationEmail()  : 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 = ['id' => 'id', 'url' => 'url', 'fee' => 'fee', 'status' => 'status', 'payment_method' => 'payment_method', 'confirmation_number' => 'confirmation_number', 'custom_fields' => 'custom_fields', 'currency_code3d' => 'currency_code3d', 'amount' => 'amount', 'card_cvv_number' => 'card_cvv_number', 'payment_date' => 'payment_date', 'payment_schedule_type' => 'payment_schedule_type', 'payment_request_date' => 'payment_request_date', 'payment_amount_type' => 'payment_amount_type', 'payment_reference' => 'payment_reference', 'expected_payment_settlement_date' => 'expected_payment_settlement_date', 'payment_entry_date' => 'payment_entry_date', 'payment_return_date' => 'payment_return_date', 'return_code' => 'return_code', 'payment_notification_email' => 'payment_notification_email', 'comments' => 'comments', 'customer' => 'customer', 'funding_account' => 'funding_account', 'customer_account' => 'customer_account', 'payment_network_response' => 'payment_network_response', 'audit_info' => 'audit_info', 'save_funding_account' => 'save_funding_account']

$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', 'confirmation_number' => 'getConfirmationNumber', 'custom_fields' => 'getCustomFields', 'currency_code3d' => 'getCurrencyCode3d', 'amount' => 'getAmount', 'card_cvv_number' => 'getCardCvvNumber', 'payment_date' => 'getPaymentDate', 'payment_schedule_type' => 'getPaymentScheduleType', 'payment_request_date' => 'getPaymentRequestDate', 'payment_amount_type' => 'getPaymentAmountType', 'payment_reference' => 'getPaymentReference', 'expected_payment_settlement_date' => 'getExpectedPaymentSettlementDate', 'payment_entry_date' => 'getPaymentEntryDate', 'payment_return_date' => 'getPaymentReturnDate', 'return_code' => 'getReturnCode', 'payment_notification_email' => 'getPaymentNotificationEmail', 'comments' => 'getComments', 'customer' => 'getCustomer', 'funding_account' => 'getFundingAccount', 'customer_account' => 'getCustomerAccount', 'payment_network_response' => 'getPaymentNetworkResponse', 'audit_info' => 'getAuditInfo', 'save_funding_account' => 'getSaveFundingAccount']

$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', 'confirmation_number' => 'setConfirmationNumber', 'custom_fields' => 'setCustomFields', 'currency_code3d' => 'setCurrencyCode3d', 'amount' => 'setAmount', 'card_cvv_number' => 'setCardCvvNumber', 'payment_date' => 'setPaymentDate', 'payment_schedule_type' => 'setPaymentScheduleType', 'payment_request_date' => 'setPaymentRequestDate', 'payment_amount_type' => 'setPaymentAmountType', 'payment_reference' => 'setPaymentReference', 'expected_payment_settlement_date' => 'setExpectedPaymentSettlementDate', 'payment_entry_date' => 'setPaymentEntryDate', 'payment_return_date' => 'setPaymentReturnDate', 'return_code' => 'setReturnCode', 'payment_notification_email' => 'setPaymentNotificationEmail', 'comments' => 'setComments', 'customer' => 'setCustomer', 'funding_account' => 'setFundingAccount', 'customer_account' => 'setCustomerAccount', 'payment_network_response' => 'setPaymentNetworkResponse', 'audit_info' => 'setAuditInfo', 'save_funding_account' => 'setSaveFundingAccount']

$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, 'confirmation_number' => null, 'custom_fields' => null, 'currency_code3d' => null, 'amount' => null, 'card_cvv_number' => null, 'payment_date' => null, 'payment_schedule_type' => null, 'payment_request_date' => null, 'payment_amount_type' => null, 'payment_reference' => null, 'expected_payment_settlement_date' => null, 'payment_entry_date' => null, 'payment_return_date' => null, 'return_code' => null, 'payment_notification_email' => 'email', 'comments' => null, 'customer' => null, 'funding_account' => null, 'customer_account' => null, 'payment_network_response' => null, 'audit_info' => null, 'save_funding_account' => 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', 'confirmation_number' => 'string', 'custom_fields' => 'map[string,string]', 'currency_code3d' => 'string', 'amount' => 'string', 'card_cvv_number' => 'string', 'payment_date' => 'string', 'payment_schedule_type' => 'string', 'payment_request_date' => 'string', 'payment_amount_type' => 'string', 'payment_reference' => 'string', 'expected_payment_settlement_date' => 'string', 'payment_entry_date' => 'string', 'payment_return_date' => 'string', 'return_code' => 'string', 'payment_notification_email' => 'string', 'comments' => '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', 'save_funding_account' => 'string']

$expected_payment_settlement_date

private string $expected_payment_settlement_date

$http_status_code

private mixed $http_status_code

$live_mode

private string $live_mode

$payment_notification_email

private string $payment_notification_email

$payment_schedule_type

private string $payment_schedule_type

$save_funding_account

private string $save_funding_account

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

createdBy()

createdBy

public createdBy([ $requestor = null ][,  $requestor_type = null ]) : SimplePayment
Parameters
$requestor : = null
$requestor_type : = null
Return values
SimplePayment —

forClient()

public forClient([mixed $client_key = null ]) : mixed
Parameters
$client_key : mixed = null
Return values
mixed —

forCustomer()

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

fromAccount()

public fromAccount([mixed $funding_account = null ][, mixed $save_funding_account = null ]) : mixed
Parameters
$funding_account : mixed = null
$save_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 'discounted_amount', 'penalty_amount' or '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 —

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.

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 —

getExpectedPaymentSettlementDate()

Gets expected_payment_settlement_date

public getExpectedPaymentSettlementDate() : string
Return values
string —

$expected_payment_settlement_date The date on which the payment is expected to be settled with the biller. It must be in ISO8601 full-date format, namely, YYYY-MM-DD.

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.

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 fulfillment method for the payment.

getPaymentNotificationEmail()

Gets payment_notification_email

public getPaymentNotificationEmail() : string
Return values
string —

$payment_notification_email The email address to which notifications for the payment will be sent. The notifications will be sent to the customer's email in case this is not provided.

getPaymentReference()

Gets payment_reference

public getPaymentReference() : string
Return values
string —

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

getPaymentRequestDate()

Gets payment_request_date

public getPaymentRequestDate() : string
Return values
string —

$payment_request_date The date on which the biller wants the payment to be settled. It must be in ISO8601 full-date format, namely, YYYY-MM-DD. This is applicable only if the client has opted for it.

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.

getSaveFundingAccount()

Gets save_funding_account

public getSaveFundingAccount() : string
Return values
string —

$save_funding_account query param

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.

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 $payment_amount_type = null ][, mixed $amount = null ][, mixed $payment_date = null ][, mixed $payment_request_date = null ][, mixed $card_cvv_number = null ]) : mixed
Parameters
$payment_amount_type : mixed = null
$amount : mixed = null
$payment_date : mixed = null
$payment_request_date : mixed = null
$card_cvv_number : 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 —

withPaymentNotificationEmail()

public withPaymentNotificationEmail([mixed $payment_notification_email = null ]) : mixed
Parameters
$payment_notification_email : mixed = null
Return values
mixed —

withReference()

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