Overview

Packages

  • blesta
    • app
      • controllers
      • models
    • components
      • auth
        • ldap
        • motp
        • oath
      • delivery
        • interfax
        • postal
          • methods
      • download
      • email
      • events
      • exchange
        • rates
          • currency
            • layer
          • fixer
          • open
            • exchange
              • rates
          • x
            • rates
      • gateway
        • payments
      • gateways
      • invoice
        • delivery
        • templates
          • perforated
            • invoice
          • quickbooks
            • invoice
          • templates
            • default
      • modules
      • net
        • amazon
          • s3
        • http
        • net
          • geo
            • ip
      • plugins
      • reports
        • aging
          • invoices
        • client
          • data
            • portability
        • custom
          • report
        • invoice
          • creation
        • package
          • revenue
        • tax
          • liability
        • transactions
          • applied
          • received
      • security
      • session
        • cart
      • settingscollection
      • upgrades
        • tasks
      • upload
      • vcard
    • core
      • Automation
        • Tasks
          • Common
          • Task
        • Type
          • Common
          • Cron
      • Pricing
        • ItemComparator
        • MetaItem
        • Modifier
          • Type
            • Description
              • Type
                • Discount
                • Option
                • Service
                • Tax
            • Discount
            • Price
            • Proration
        • Presenter
          • Build
            • Invoice
            • InvoiceData
            • Options
            • Service
            • ServiceChange
            • ServiceData
          • Collection
          • Format
            • Fields
            • Type
              • Discount
              • Item
              • Option
              • Options
              • Package
              • Pricing
              • Service
              • Tax
          • Items
            • Invoice
            • Service
          • Type
      • ServiceProviders
      • Util
        • Captcha
          • Captchas
          • Common
        • Common
          • Traits
        • Events
          • Common
          • Handlers
          • Observers
        • Filters
          • Common
        • GeoIp
        • Input
          • Fields
            • Common
        • Tax
        • Widgets
    • helpers
      • currency
        • format
      • data
        • structure
          • array
          • string
      • text
        • parser
      • widget
        • client
  • minPHP
    • helpers
      • color
      • data
        • structure
  • None
  • PHP

Classes

  • Gateway
  • Gateways
  • MerchantGateway
  • NonmerchantGateway

Interfaces

  • MerchantAch
  • MerchantAchOffsite
  • MerchantCc
  • MerchantCcForm
  • MerchantCcOffsite
  • Overview
  • Package
  • Class
  • Tree
  • Deprecated

Class MerchantGateway

Abstract class that all Merchant Gateways must extend

Gateway uses Blesta\Core\Util\Common\Traits\Container
Extended by MerchantGateway
Abstract
Package: blesta\components\gateways
Copyright: Copyright (c) 2010, Phillips Data, Inc.
License: The Blesta License Agreement
Link: Blesta
Located at components/gateways/lib/merchant_gateway.php
Methods summary
abstract public boolean
# requiresCustomerPresent( )

Used to determine whether this gateway can be configured for autodebiting accounts

Used to determine whether this gateway can be configured for autodebiting accounts

Returns

boolean

True if the customer must be present (e.g. in the case of credit card customer must enter security code), false otherwise

protected
# httpRequest( string $method, string $url = null, mixed $params = null )

Process a request over HTTP using the supplied method type, url and parameters.

Process a request over HTTP using the supplied method type, url and parameters.

Parameters

$method
The method type (e.g. GET, POST)
$url
The URL to post to
$params
array of parameters or a URL encoded list of key/value pairs
protected mixed
# getCommonError( string $type )

Fetches an array containing the error response to be set using Input::setErrors()

Fetches an array containing the error response to be set using Input::setErrors()

Parameters

$type

The type of error to fetch. Values include:

  • card_number_invalid
  • card_expired
  • routing_number_invalid
  • account_number_invalid
  • duplicate_transaction
  • card_not_accepted
  • invalid_security_code
  • address_verification_failed
  • transaction_not_found The transaction was not found on the remote gateway
  • unsupported The action is not supported by the gateway
  • general A general error occurred

Returns

mixed

An array containing the error to populate using Input::setErrors(), false if the type does not exist

Methods inherited from Gateway
clientIdFromEmail(), editSettings(), encryptableFields(), errors(), getAuthors(), getCurrencies(), getDescription(), getLogo(), getName(), getSettings(), getSignupUrl(), getVersion(), ifSet(), install(), loadConfig(), log(), makeView(), maskData(), maskDataRecursive(), setCurrency(), setGatewayId(), setMeta(), setStaffId(), uninstall(), upgrade()
Methods used from Blesta\Core\Util\Common\Traits\Container
getFromContainer()
Properties summary
protected Http $Http

An Http object, used to make HTTP requests

An Http object, used to make HTTP requests

#
Properties inherited from Gateway
$config
Blesta API documentation generated by ApiGen