CreatePaymentRequest
in package
implements
ModelInterface, ArrayAccess
Warning:
This class subject to change without prior notice, Please dont use this class directly.
Tags
Interfaces, Classes and Traits
- ModelInterface
- Warning:
- ArrayAccess
Table of Contents
- DISCRIMINATOR = null
- PAYMENT_AMOUNT_TYPE_CURRENT_BALANCE = 'current_balance'
- PAYMENT_AMOUNT_TYPE_DISCOUNTED_AMOUNT = 'discounted_amount'
- PAYMENT_AMOUNT_TYPE_MINIMUM_PAYMENT_DUE = 'minimum_payment_due'
- PAYMENT_AMOUNT_TYPE_OTHER = 'other'
- PAYMENT_AMOUNT_TYPE_PAST_PAYMENT_DUE = 'past_payment_due'
- PAYMENT_AMOUNT_TYPE_PENALTY_AMOUNT = 'penalty_amount'
- PAYMENT_AMOUNT_TYPE_STATEMENT_BALANCE = 'statement_balance'
- $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
- getAmount() : string
- Gets amount
- getCardCvvNumber() : string
- Gets card_cvv_number
- getComments() : string
- Gets comments
- getCustomer() : CustomerMinimalRequest
- Gets customer
- getCustomerAccount() : CustomerAccountMinimalRequest
- Gets customer_account
- getCustomFields() : mixed
- Gets custom_fields
- getFee() : FeeRequest
- Gets fee
- getFundingAccount() : FundingAccountMinimalRequest
- Gets funding_account
- getModelName() : string
- The original name of the model.
- getPaymentAmountType() : string
- Gets payment_amount_type
- getPaymentAmountTypeAllowableValues() : array<string|int, string>
- Gets allowable values of the enum
- getPaymentDate() : string
- Gets payment_date
- getPaymentNotificationEmail() : string
- Gets payment_notification_email
- getPaymentReference() : string
- Gets payment_reference
- getPaymentRequestDate() : string
- Gets payment_request_date
- getters() : array<string|int, mixed>
- Array of attributes to getter functions (for serialization of requests)
- offsetExists() : bool
- Returns true if offset exists. False otherwise.
- offsetGet() : mixed
- Gets offset.
- offsetSet() : void
- Sets value based on offset.
- offsetUnset() : void
- Unsets offset.
- setAmount() : $this
- Sets amount
- setCardCvvNumber() : $this
- Sets card_cvv_number
- setComments() : $this
- Sets comments
- setCustomer() : $this
- Sets customer
- setCustomerAccount() : $this
- Sets customer_account
- setCustomFields() : $this
- Sets custom_fields
- setFee() : $this
- Sets fee
- setFundingAccount() : $this
- Sets funding_account
- setPaymentAmountType() : $this
- Sets payment_amount_type
- setPaymentDate() : $this
- Sets payment_date
- setPaymentNotificationEmail() : $this
- Sets payment_notification_email
- setPaymentReference() : $this
- Sets payment_reference
- setPaymentRequestDate() : $this
- Sets payment_request_date
- 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
DISCRIMINATOR
public
mixed
DISCRIMINATOR
= null
PAYMENT_AMOUNT_TYPE_CURRENT_BALANCE
public
mixed
PAYMENT_AMOUNT_TYPE_CURRENT_BALANCE
= 'current_balance'
PAYMENT_AMOUNT_TYPE_DISCOUNTED_AMOUNT
public
mixed
PAYMENT_AMOUNT_TYPE_DISCOUNTED_AMOUNT
= 'discounted_amount'
PAYMENT_AMOUNT_TYPE_MINIMUM_PAYMENT_DUE
public
mixed
PAYMENT_AMOUNT_TYPE_MINIMUM_PAYMENT_DUE
= 'minimum_payment_due'
PAYMENT_AMOUNT_TYPE_OTHER
public
mixed
PAYMENT_AMOUNT_TYPE_OTHER
= 'other'
PAYMENT_AMOUNT_TYPE_PAST_PAYMENT_DUE
public
mixed
PAYMENT_AMOUNT_TYPE_PAST_PAYMENT_DUE
= 'past_payment_due'
PAYMENT_AMOUNT_TYPE_PENALTY_AMOUNT
public
mixed
PAYMENT_AMOUNT_TYPE_PENALTY_AMOUNT
= 'penalty_amount'
PAYMENT_AMOUNT_TYPE_STATEMENT_BALANCE
public
mixed
PAYMENT_AMOUNT_TYPE_STATEMENT_BALANCE
= 'statement_balance'
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
= ['amount' => 'amount', 'card_cvv_number' => 'card_cvv_number', 'payment_date' => 'payment_date', 'payment_request_date' => 'payment_request_date', 'payment_amount_type' => 'payment_amount_type', 'fee' => 'fee', 'customer' => 'customer', 'funding_account' => 'funding_account', 'customer_account' => 'customer_account', 'payment_reference' => 'payment_reference', 'payment_notification_email' => 'payment_notification_email', 'comments' => 'comments', 'custom_fields' => 'custom_fields']
$container
Associative array for storing property values
protected
array<string|int, mixed>
$container
= []
$getters
Array of attributes to getter functions (for serialization of requests)
protected
static array<string|int, string>
$getters
= ['amount' => 'getAmount', 'card_cvv_number' => 'getCardCvvNumber', 'payment_date' => 'getPaymentDate', 'payment_request_date' => 'getPaymentRequestDate', 'payment_amount_type' => 'getPaymentAmountType', 'fee' => 'getFee', 'customer' => 'getCustomer', 'funding_account' => 'getFundingAccount', 'customer_account' => 'getCustomerAccount', 'payment_reference' => 'getPaymentReference', 'payment_notification_email' => 'getPaymentNotificationEmail', 'comments' => 'getComments', 'custom_fields' => 'getCustomFields']
$setters
Array of attributes to setter functions (for deserialization of responses)
protected
static array<string|int, string>
$setters
= ['amount' => 'setAmount', 'card_cvv_number' => 'setCardCvvNumber', 'payment_date' => 'setPaymentDate', 'payment_request_date' => 'setPaymentRequestDate', 'payment_amount_type' => 'setPaymentAmountType', 'fee' => 'setFee', 'customer' => 'setCustomer', 'funding_account' => 'setFundingAccount', 'customer_account' => 'setCustomerAccount', 'payment_reference' => 'setPaymentReference', 'payment_notification_email' => 'setPaymentNotificationEmail', 'comments' => 'setComments', 'custom_fields' => 'setCustomFields']
$swaggerFormats
Array of property to format mappings. Used for (de)serialization
protected
static array<string|int, string>
$swaggerFormats
= ['amount' => null, 'card_cvv_number' => null, 'payment_date' => null, 'payment_request_date' => null, 'payment_amount_type' => null, 'fee' => null, 'customer' => null, 'funding_account' => null, 'customer_account' => null, 'payment_reference' => null, 'payment_notification_email' => 'email', 'comments' => null, 'custom_fields' => null]
$swaggerModelName
The original name of the model.
protected
static string
$swaggerModelName
= 'CreatePaymentRequest'
$swaggerTypes
Array of property to type mappings. Used for (de)serialization
protected
static array<string|int, string>
$swaggerTypes
= ['amount' => 'string', 'card_cvv_number' => 'string', 'payment_date' => 'string', 'payment_request_date' => 'string', 'payment_amount_type' => 'string', 'fee' => '\Orbipay\PaymentsApi\Client\Model\FeeRequest', 'customer' => '\Orbipay\PaymentsApi\Client\Model\CustomerMinimalRequest', 'funding_account' => '\Orbipay\PaymentsApi\Client\Model\FundingAccountMinimalRequest', 'customer_account' => '\Orbipay\PaymentsApi\Client\Model\CustomerAccountMinimalRequest', 'payment_reference' => 'string', 'payment_notification_email' => 'string', 'comments' => 'string', 'custom_fields' => 'map[string,string]']
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 —__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> —getAmount()
Gets amount
public
getAmount() : string
Return values
string —getCardCvvNumber()
Gets card_cvv_number
public
getCardCvvNumber() : string
Return values
string —getComments()
Gets comments
public
getComments() : string
Return values
string —getCustomer()
Gets customer
public
getCustomer() : CustomerMinimalRequest
Return values
CustomerMinimalRequest —getCustomerAccount()
Gets customer_account
public
getCustomerAccount() : CustomerAccountMinimalRequest
Return values
CustomerAccountMinimalRequest —getCustomFields()
Gets custom_fields
public
getCustomFields() : mixed
Return values
mixed —getFee()
Gets fee
public
getFee() : FeeRequest
Return values
FeeRequest —getFundingAccount()
Gets funding_account
public
getFundingAccount() : FundingAccountMinimalRequest
Return values
FundingAccountMinimalRequest —getModelName()
The original name of the model.
public
getModelName() : string
Return values
string —getPaymentAmountType()
Gets payment_amount_type
public
getPaymentAmountType() : string
Return values
string —getPaymentAmountTypeAllowableValues()
Gets allowable values of the enum
public
getPaymentAmountTypeAllowableValues() : array<string|int, string>
Return values
array<string|int, string> —getPaymentDate()
Gets payment_date
public
getPaymentDate() : string
Return values
string —getPaymentNotificationEmail()
Gets payment_notification_email
public
getPaymentNotificationEmail() : string
Return values
string —getPaymentReference()
Gets payment_reference
public
getPaymentReference() : string
Return values
string —getPaymentRequestDate()
Gets payment_request_date
public
getPaymentRequestDate() : string
Return values
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 —setAmount()
Sets amount
public
setAmount(string $amount) : $this
Parameters
- $amount : string
-
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.
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 —setCustomer()
Sets customer
public
setCustomer(CustomerMinimalRequest $customer) : $this
Parameters
- $customer : CustomerMinimalRequest
-
customer
Return values
$this —setCustomerAccount()
Sets customer_account
public
setCustomerAccount(CustomerAccountMinimalRequest $customer_account) : $this
Parameters
- $customer_account : CustomerAccountMinimalRequest
-
customer_account
Return values
$this —setCustomFields()
Sets custom_fields
public
setCustomFields(mixed $custom_fields) : $this
Parameters
- $custom_fields : mixed
Return values
$this —setFee()
Sets fee
public
setFee(FeeRequest $fee) : $this
Parameters
- $fee : FeeRequest
-
fee
Return values
$this —setFundingAccount()
Sets funding_account
public
setFundingAccount(FundingAccountMinimalRequest $funding_account) : $this
Parameters
- $funding_account : FundingAccountMinimalRequest
-
funding_account
Return values
$this —setPaymentAmountType()
Sets payment_amount_type
public
setPaymentAmountType(string $payment_amount_type) : $this
Parameters
- $payment_amount_type : string
-
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.
Return values
$this —setPaymentDate()
Sets payment_date
public
setPaymentDate(string $payment_date) : $this
Parameters
- $payment_date : string
-
The date on which the payment is scheduled to be made. It must be in ISO8601 full-date format, namely, YYYY-MM-DD.
Return values
$this —setPaymentNotificationEmail()
Sets payment_notification_email
public
setPaymentNotificationEmail(string $payment_notification_email) : $this
Parameters
- $payment_notification_email : string
-
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.
Return values
$this —setPaymentReference()
Sets payment_reference
public
setPaymentReference(string $payment_reference) : $this
Parameters
- $payment_reference : string
-
The unique identifier in the client system for the payment.
Return values
$this —setPaymentRequestDate()
Sets payment_request_date
public
setPaymentRequestDate(string $payment_request_date) : $this
Parameters
- $payment_request_date : string
-
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.
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> —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>