ModelInvoices module

MockPayPaymentMethod

Class MockPayPaymentMethod

A model in the Invoices module, with 17 members for templates, 14 API properties and 23 members for admin templates.

Invoices\Models\Frontend\MockPayPaymentMethod Invoices\Models\Api\MockPayPaymentMethod Invoices\Models\Backend\MockPayPaymentMethod Also in Invoices: Invoice InvoiceCustomFieldValue Item PayPalDonatePaymentMethod PayPalPaymentMethod Refund RefundItem StripePaymentMethod Transaction
View
What Smarty and Twig templates receive. Properties in REST API responses and job payloads. What admin screen templates receive when you override them.

Templates view

Properties 17

Take no arguments.

# getFailureRate()
string
Get the failure rate
# isAuthorizationSupported()
bool
Is authorization supported?
# isPartialCaptureSupported()
?bool
Is partial capture supported?
# isRefundsSupported()
bool
Is refunds supported?
# getPaymentServiceProviderName()
string
Get the name of the payment service provider.
# getPaymentServiceProviderType()
string
Get the payment service provider type. Integrators can use this to determine what payment service provider this payment method belongs to.
# getId()
?int
# getName()
?string
# getPosition()
?int
# isTestMode()
bool
# getCreated()
?DateTime
Date the record was created.
# getModified()
?DateTime
Last modification date for the record.
# isActive()
bool
# getSite()
?Site
# isNewRecord() Not in API & Jobs
bool
Check if the record is a new record
# isHierarchicalModel() Not in API & Jobs
bool
Check whether a model is a hierarchical model, i.e. can have children
# isVersionedModel() Not in API & Jobs
bool
Check whether a model is versioned

API & Jobs view

API & JobsEach property is a key in REST API responses and job payloads. Its name is the template getter without get, is or has. Methods that need arguments are not available here.

Properties 14

Read-only values on the record.

# failureRate
string
Get the failure rate
# authorizationSupported
bool
Is authorization supported?
# partialCaptureSupported
?bool
Is partial capture supported?
# refundsSupported
bool
Is refunds supported?
# paymentServiceProviderName
string
Get the name of the payment service provider.
# paymentServiceProviderType
string
Get the payment service provider type. Integrators can use this to determine what payment service provider this payment method belongs to.
# id
?int
# name
?string
# position
?int
# testMode
bool
# created
?DateTime
Date the record was created.
# modified
?DateTime
Last modification date for the record.
# active
bool
# site
?Site

Admin view

AdminAvailable in cdna-admin templates. Copy an admin template into your site repository to change how this record is edited.

Properties 23

Take no arguments.

# getFailureRate()
string
Get the failure rate
# isAuthorizationSupported()
bool
Is authorization supported?
# isPartialCaptureSupported()
?bool
Is partial capture supported?
# isRefundsSupported()
bool
Is refunds supported?
# getPaymentServiceProviderName()
string
Get the name of the payment service provider.
# getPaymentServiceProviderType()
string
Get the payment service provider type. Integrators can use this to determine what payment service provider this payment method belongs to.
# getId()
?int
# getName()
?string
# getPosition()
?int
# isTestMode()
bool
# getCreated()
?DateTime
Date the record was created.
# getModified()
?DateTime
Last modification date for the record.
# isActive()
bool
# getSite()
?Site
# isNewRecord() Not in API & Jobs
bool
Check if the record is a new record
# isHierarchicalModel() Not in API & Jobs
bool
Check whether a model is a hierarchical model, i.e. can have children
# isVersionedModel() Not in API & Jobs
bool
Check whether a model is versioned
# getAvailableFailureRates() Admin only
array
Get available failure rates
# getEditUrl() Admin only
?string
Get the url for editing the record.
# getMoveUrl() Admin only
?string
Get the url for moving the record.
# getDeleteUrl() Admin only
?string
Get the url for deleting the record.
# getManageUrl() Admin only
?string
Get the url for managing records.