\Commerce\RecurringSales\StoredCards
Templating
Global Functions
Website
\Components\Website\Designs \Components\Website\Media \Components\Website\Pages \Components\Website\Pages\Forms \Components\Website\Posts \Components\Website\Posts\Categories
Customers
\Components\Customers\Contacts \Components\Customers\Contacts\Relationships \Components\Customers\Contacts\Relationships\Types \Components\Customers\Groups
Marketing
\Components\Marketing\EmailMarketing \Components\Marketing\Events \Components\Marketing\Events\Attendees \Components\Marketing\Events\Categories \Components\Marketing\Events\Locations
Commerce
\Components\Commerce\Carts \Components\Commerce\Carts\Current \Components\Commerce\Configuration\PaymentMethods \Components\Commerce\Configuration\ShippingMethods \Components\Commerce\Discounts \Components\Commerce\Products \Components\Commerce\Products\Brands \Components\Commerce\Products\Categories \Components\Commerce\Products\Inventory \Components\Commerce\Sales \Components\Commerce\Sales\Items \Components\Commerce\Sales\Receipts \Components\Commerce\Sales\Receipts\Allocations
Settings
\Components\Settings\Administrators \Components\Settings\CustomFields \Components\Settings\Domains
Other Apps
\Components\Website\Comments \Components\Commerce\Affiliates \Components\Commerce\Affiliates\Administrators \Components\Commerce\Affiliates\Commissions \Components\Commerce\Affiliates\Payments \Components\Commerce\RecurringSales \Components\Commerce\RecurringSales\StoredCards
DESCRIPTION
METHODS
delete()
get()
getAll()
getColumn()
getContactHasAccounts()
getCount()
save()
saveColumn()
search()
Framework
\Framework\Caching \Framework\Data\Util \Framework\DOM\CurrentContext \Framework\HTML\Converters \Framework\HTTP\Cookies \Framework\HTTP\Redirection \Framework\HTTP\Request \Framework\HTTP\Session \Framework\HTTP\UserAgent \Framework\I18N\CompanyTypes \Framework\I18N\Countries \Framework\I18N\Languages \Framework\Network\GeoIP

StoredCards

Use this API to create, update and delete stored payment cards for contacts.

Methods

Invoke via \Components\Commerce\RecurringSales\StoredCards::method()
Click a method name to copy it.
- ` bool delete($iContactId, $bDeleteMedia) `
Deletes a record from the database
Parameters:
- $iContactId
int
A record's contact_id
- $bDeleteMedia
mixed
Return
Returns true if record existed and was deleted, otherwise false
- ` array get($iContactId) `
Gets a record from the database
Parameters:
- $iContactId
int
A record's contact_id
Return
StoredCards
- ` array getAll($arrQuery) `
Return a set of records from the database
Parameters:
- $arrQuery
mixed
Return
Array of StoredCards
- ` mixed getColumn($iContactId, $strColumn) `
Gets a single field from a record
Parameters:
- $iContactId
int
A record's contact_id
- $strColumn
mixed
Return
mixed
- ` bool getContactHasAccounts($iContactId) `
Determines if a contact has recurring billing accounts
Parameters:
- $iContactId
mixed
Return
bool
- ` int getCount($arrFilter) `
Returns the number of records in the database (matching the filter if specified)
Parameters:
- $arrFilter
mixed
Return
int
- ` string|int save($arrEntity) `
Saves a record into the database
Parameters:
- $arrEntity
mixed
Return
string|int
- ` void saveColumn($iContactId, $strColumn, $strValue) `
Saves a specific column of a row into a database
Parameters:
- $iContactId
int
A record's contact_id
- $strColumn
mixed
- $strValue
mixed
- ` array search($strSearch, $arrQuery) `
Performs a search
Parameters:
- $strSearch
mixed
- $arrQuery
mixed
Return
Array of StoredCards that match the search query.

Database Fields

The following fields are used when retrieving and saving entities:
- `contact_id`
int (10)
- `payment_method_id`
int (11)
- `stored_card_gateway`
string (255)
- `stored_card_gateway_id`
string (127)
- `stored_card_apikey`
string (127)
- `stored_card_configuration`
string (65535)
- `stored_card_renderable`
string (255)
- `stored_card_expiry_mm`
int unsigned
- `stored_card_expiry_yy`
int unsigned