PaymentResponse
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'
- PAYMENT_METHOD_ACH = 'ach'
- PAYMENT_METHOD_AMEX_CREDIT = 'amex_credit'
- PAYMENT_METHOD_APPLE_PAY = 'apple_pay'
- PAYMENT_METHOD_CASH = 'cash'
- PAYMENT_METHOD_CHECK = 'check'
- PAYMENT_METHOD_DISCOVER_CREDIT = 'discover_credit'
- PAYMENT_METHOD_DISCOVER_DEBIT = 'discover_debit'
- PAYMENT_METHOD_MASTER_CREDIT = 'master_credit'
- PAYMENT_METHOD_MASTER_DEBIT = 'master_debit'
- PAYMENT_METHOD_PINLESS_DEBIT = 'pinless_debit'
- PAYMENT_METHOD_SCANNED_CHECK = 'scanned_check'
- PAYMENT_METHOD_SWIPED_CARD = 'swiped_card'
- PAYMENT_METHOD_VISA_CREDIT = 'visa_credit'
- PAYMENT_METHOD_VISA_DEBIT = 'visa_debit'
- PAYMENT_SCHEDULE_TYPE_AUTOPAY_GENERATED_PAYMENT = 'autopay_generated_payment'
- PAYMENT_SCHEDULE_TYPE_ONE_TIME_PAYMENT = 'one_time_payment'
- PAYMENT_SCHEDULE_TYPE_PAYMENT_PLAN_GENERATED = 'payment_plan_generated'
- PAYMENT_SCHEDULE_TYPE_VARIABLE_RECURRING_GENERATED_PAYMENT = 'variable_recurring_generated_payment'
- STATUS_CANCELLED = 'cancelled'
- STATUS_DECLINED = 'declined'
- STATUS_DISPUTED = 'disputed'
- STATUS_ERROR = 'error'
- STATUS_PROCESSED = 'processed'
- STATUS_PROCESSING = 'processing'
- STATUS_RETURNED = 'returned'
- STATUS_SCHEDULED = 'scheduled'
- $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
- getAuditInfo() : AuditInfoVo
- Gets audit_info
- getCardCvvNumber() : string
- Gets card_cvv_number
- getComments() : string
- Gets comments
- getConfirmationNumber() : string
- Gets confirmation_number
- getCurrencyCode3d() : string
- Gets currency_code3d
- getCustomer() : CustomerSnapshotResponse
- Gets customer
- getCustomerAccount() : CustomerAccountSnapshotResponse
- Gets customer_account
- getCustomFields() : mixed
- Gets custom_fields
- getExpectedPaymentSettlementDate() : string
- Gets expected_payment_settlement_date
- getFee() : FeeResponse
- Gets fee
- getFundingAccount() : FundingAccountSnapshotResponse
- Gets funding_account
- getId() : string
- Gets id
- 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
- getPaymentEntryDate() : string
- Gets payment_entry_date
- getPaymentMethod() : string
- Gets payment_method
- getPaymentMethodAllowableValues() : array<string|int, string>
- Gets allowable values of the enum
- getPaymentNetworkResponse() : PaymentNetworkResponseVo
- 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
- getPaymentScheduleTypeAllowableValues() : array<string|int, string>
- Gets allowable values of the enum
- getReturnCode() : string
- Gets return_code
- 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)
- getToken() : string
- Gets token
- 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.
- setAmount() : $this
- Sets amount
- setAuditInfo() : $this
- Sets audit_info
- setCardCvvNumber() : $this
- Sets card_cvv_number
- setComments() : $this
- Sets comments
- setConfirmationNumber() : $this
- Sets confirmation_number
- setCurrencyCode3d() : $this
- Sets currency_code3d
- setCustomer() : $this
- Sets customer
- setCustomerAccount() : $this
- Sets customer_account
- setCustomFields() : $this
- Sets custom_fields
- setExpectedPaymentSettlementDate() : $this
- Sets expected_payment_settlement_date
- setFee() : $this
- Sets fee
- setFundingAccount() : $this
- Sets funding_account
- setId() : $this
- Sets id
- setPaymentAmountType() : $this
- Sets payment_amount_type
- setPaymentDate() : $this
- Sets payment_date
- setPaymentEntryDate() : $this
- Sets payment_entry_date
- setPaymentMethod() : $this
- Sets payment_method
- setPaymentNetworkResponse() : $this
- Sets payment_network_response
- setPaymentNotificationEmail() : $this
- Sets payment_notification_email
- setPaymentReference() : $this
- Sets payment_reference
- setPaymentRequestDate() : $this
- Sets payment_request_date
- setPaymentReturnDate() : $this
- Sets payment_return_date
- setPaymentScheduleType() : $this
- Sets payment_schedule_type
- setReturnCode() : $this
- Sets return_code
- setStatus() : $this
- Sets status
- setters() : array<string|int, mixed>
- Array of attributes to setter functions (for deserialization of responses)
- setToken() : $this
- Sets token
- 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
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'
PAYMENT_METHOD_ACH
public
mixed
PAYMENT_METHOD_ACH
= 'ach'
PAYMENT_METHOD_AMEX_CREDIT
public
mixed
PAYMENT_METHOD_AMEX_CREDIT
= 'amex_credit'
PAYMENT_METHOD_APPLE_PAY
public
mixed
PAYMENT_METHOD_APPLE_PAY
= 'apple_pay'
PAYMENT_METHOD_CASH
public
mixed
PAYMENT_METHOD_CASH
= 'cash'
PAYMENT_METHOD_CHECK
public
mixed
PAYMENT_METHOD_CHECK
= 'check'
PAYMENT_METHOD_DISCOVER_CREDIT
public
mixed
PAYMENT_METHOD_DISCOVER_CREDIT
= 'discover_credit'
PAYMENT_METHOD_DISCOVER_DEBIT
public
mixed
PAYMENT_METHOD_DISCOVER_DEBIT
= 'discover_debit'
PAYMENT_METHOD_MASTER_CREDIT
public
mixed
PAYMENT_METHOD_MASTER_CREDIT
= 'master_credit'
PAYMENT_METHOD_MASTER_DEBIT
public
mixed
PAYMENT_METHOD_MASTER_DEBIT
= 'master_debit'
PAYMENT_METHOD_PINLESS_DEBIT
public
mixed
PAYMENT_METHOD_PINLESS_DEBIT
= 'pinless_debit'
PAYMENT_METHOD_SCANNED_CHECK
public
mixed
PAYMENT_METHOD_SCANNED_CHECK
= 'scanned_check'
PAYMENT_METHOD_SWIPED_CARD
public
mixed
PAYMENT_METHOD_SWIPED_CARD
= 'swiped_card'
PAYMENT_METHOD_VISA_CREDIT
public
mixed
PAYMENT_METHOD_VISA_CREDIT
= 'visa_credit'
PAYMENT_METHOD_VISA_DEBIT
public
mixed
PAYMENT_METHOD_VISA_DEBIT
= 'visa_debit'
PAYMENT_SCHEDULE_TYPE_AUTOPAY_GENERATED_PAYMENT
public
mixed
PAYMENT_SCHEDULE_TYPE_AUTOPAY_GENERATED_PAYMENT
= 'autopay_generated_payment'
PAYMENT_SCHEDULE_TYPE_ONE_TIME_PAYMENT
public
mixed
PAYMENT_SCHEDULE_TYPE_ONE_TIME_PAYMENT
= 'one_time_payment'
PAYMENT_SCHEDULE_TYPE_PAYMENT_PLAN_GENERATED
public
mixed
PAYMENT_SCHEDULE_TYPE_PAYMENT_PLAN_GENERATED
= 'payment_plan_generated'
PAYMENT_SCHEDULE_TYPE_VARIABLE_RECURRING_GENERATED_PAYMENT
public
mixed
PAYMENT_SCHEDULE_TYPE_VARIABLE_RECURRING_GENERATED_PAYMENT
= 'variable_recurring_generated_payment'
STATUS_CANCELLED
public
mixed
STATUS_CANCELLED
= 'cancelled'
STATUS_DECLINED
public
mixed
STATUS_DECLINED
= 'declined'
STATUS_DISPUTED
public
mixed
STATUS_DISPUTED
= 'disputed'
STATUS_ERROR
public
mixed
STATUS_ERROR
= 'error'
STATUS_PROCESSED
public
mixed
STATUS_PROCESSED
= 'processed'
STATUS_PROCESSING
public
mixed
STATUS_PROCESSING
= 'processing'
STATUS_RETURNED
public
mixed
STATUS_RETURNED
= 'returned'
STATUS_SCHEDULED
public
mixed
STATUS_SCHEDULED
= 'scheduled'
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
= ['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', 'token' => 'token', 'customer' => 'customer', 'funding_account' => 'funding_account', 'customer_account' => 'customer_account', 'payment_network_response' => 'payment_network_response', 'audit_info' => 'audit_info']
$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
= ['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', 'token' => 'getToken', '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
= ['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', 'token' => 'setToken', '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
= ['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, 'token' => 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
= 'PaymentResponse'
$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\Model\FeeResponse', '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', 'token' => 'string', 'customer' => '\Orbipay\PaymentsApi\Client\Model\CustomerSnapshotResponse', 'funding_account' => '\Orbipay\PaymentsApi\Client\Model\FundingAccountSnapshotResponse', 'customer_account' => '\Orbipay\PaymentsApi\Client\Model\CustomerAccountSnapshotResponse', '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 —__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 —getAuditInfo()
Gets audit_info
public
getAuditInfo() : AuditInfoVo
Return values
AuditInfoVo —getCardCvvNumber()
Gets card_cvv_number
public
getCardCvvNumber() : string
Return values
string —getComments()
Gets comments
public
getComments() : string
Return values
string —getConfirmationNumber()
Gets confirmation_number
public
getConfirmationNumber() : string
Return values
string —getCurrencyCode3d()
Gets currency_code3d
public
getCurrencyCode3d() : string
Return values
string —getCustomer()
Gets customer
public
getCustomer() : CustomerSnapshotResponse
Return values
CustomerSnapshotResponse —getCustomerAccount()
Gets customer_account
public
getCustomerAccount() : CustomerAccountSnapshotResponse
Return values
CustomerAccountSnapshotResponse —getCustomFields()
Gets custom_fields
public
getCustomFields() : mixed
Return values
mixed —getExpectedPaymentSettlementDate()
Gets expected_payment_settlement_date
public
getExpectedPaymentSettlementDate() : string
Return values
string —getFee()
Gets fee
public
getFee() : FeeResponse
Return values
FeeResponse —getFundingAccount()
Gets funding_account
public
getFundingAccount() : FundingAccountSnapshotResponse
Return values
FundingAccountSnapshotResponse —getId()
Gets id
public
getId() : string
Return values
string —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 —getPaymentEntryDate()
Gets payment_entry_date
public
getPaymentEntryDate() : string
Return values
string —getPaymentMethod()
Gets payment_method
public
getPaymentMethod() : string
Return values
string —getPaymentMethodAllowableValues()
Gets allowable values of the enum
public
getPaymentMethodAllowableValues() : array<string|int, string>
Return values
array<string|int, string> —getPaymentNetworkResponse()
Gets payment_network_response
public
getPaymentNetworkResponse() : PaymentNetworkResponseVo
Return values
PaymentNetworkResponseVo —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 —getPaymentReturnDate()
Gets payment_return_date
public
getPaymentReturnDate() : string
Return values
string —getPaymentScheduleType()
Gets payment_schedule_type
public
getPaymentScheduleType() : string
Return values
string —getPaymentScheduleTypeAllowableValues()
Gets allowable values of the enum
public
getPaymentScheduleTypeAllowableValues() : array<string|int, string>
Return values
array<string|int, string> —getReturnCode()
Gets return_code
public
getReturnCode() : string
Return values
string —getStatus()
Gets status
public
getStatus() : string
Return values
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> —getToken()
Gets token
public
getToken() : string
Return values
string —getUrl()
Gets url
public
getUrl() : string
Return values
string —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 —setAuditInfo()
Sets audit_info
public
setAuditInfo(AuditInfoVo $audit_info) : $this
Parameters
- $audit_info : AuditInfoVo
-
audit_info
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 —setConfirmationNumber()
Sets confirmation_number
public
setConfirmationNumber(string $confirmation_number) : $this
Parameters
- $confirmation_number : string
-
The confirmation number or reference provided to the customer for the payment.
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 —setCustomer()
Sets customer
public
setCustomer(CustomerSnapshotResponse $customer) : $this
Parameters
- $customer : CustomerSnapshotResponse
-
customer
Return values
$this —setCustomerAccount()
Sets customer_account
public
setCustomerAccount(CustomerAccountSnapshotResponse $customer_account) : $this
Parameters
- $customer_account : CustomerAccountSnapshotResponse
-
customer_account
Return values
$this —setCustomFields()
Sets custom_fields
public
setCustomFields(mixed $custom_fields) : $this
Parameters
- $custom_fields : mixed
Return values
$this —setExpectedPaymentSettlementDate()
Sets expected_payment_settlement_date
public
setExpectedPaymentSettlementDate(string $expected_payment_settlement_date) : $this
Parameters
- $expected_payment_settlement_date : string
-
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.
Return values
$this —setFee()
Sets fee
public
setFee(FeeResponse $fee) : $this
Parameters
- $fee : FeeResponse
-
fee
Return values
$this —setFundingAccount()
Sets funding_account
public
setFundingAccount(FundingAccountSnapshotResponse $funding_account) : $this
Parameters
- $funding_account : FundingAccountSnapshotResponse
-
funding_account
Return values
$this —setId()
Sets id
public
setId(string $id) : $this
Parameters
- $id : string
-
The unique identifier assigned by EBPP to the payment.
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 —setPaymentEntryDate()
Sets payment_entry_date
public
setPaymentEntryDate(string $payment_entry_date) : $this
Parameters
- $payment_entry_date : string
-
The date on which the payment is captured in EBPP. It must be in ISO8601 full-date format, namely, YYYY-MM-DD.
Return values
$this —setPaymentMethod()
Sets payment_method
public
setPaymentMethod(string $payment_method) : $this
Parameters
- $payment_method : string
-
The fulfillment method for the payment.
Return values
$this —setPaymentNetworkResponse()
Sets payment_network_response
public
setPaymentNetworkResponse(PaymentNetworkResponseVo $payment_network_response) : $this
Parameters
- $payment_network_response : PaymentNetworkResponseVo
-
payment_network_response
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 —setPaymentReturnDate()
Sets payment_return_date
public
setPaymentReturnDate(string $payment_return_date) : $this
Parameters
- $payment_return_date : string
-
The date on which the ACH returns is received by EBPP.
Return values
$this —setPaymentScheduleType()
Sets payment_schedule_type
public
setPaymentScheduleType(string $payment_schedule_type) : $this
Parameters
- $payment_schedule_type : string
-
The schedule type for the payment. This defaults to one_time_payment.
Return values
$this —setReturnCode()
Sets return_code
public
setReturnCode(string $return_code) : $this
Parameters
- $return_code : string
-
The ACH return code or the chargeback code received from Visa/Mastercard, in the event of returned payments.
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> —setToken()
Sets token
public
setToken(string $token) : $this
Parameters
- $token : string
-
The token is used to uniquely identify the payment, such as the POS token.
Return values
$this —setUrl()
Sets url
public
setUrl(string $url) : $this
Parameters
- $url : string
-
This URL fetches the details of payment.
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>