Interface GatewayInterface

Payment gateway interface

This interface class defines the standard functions that any Omnipay gateway needs to define.

Direct known implementers

Omnipay\Common\AbstractGateway

Indirect known implementers

Omnipay\Dummy\Gateway, Omnipay\Fatzebra\FatzebraGateway

Namespace: Omnipay\Common
See: Omnipay\Common\AbstractGateway
Located at Common/GatewayInterface.php

Methods summary
`public`	# `getName( )` Get gateway display name Get gateway display name This can be used by carts to get the display name for each gateway.
`public`	# `getShortName( )` Get gateway short name Get gateway short name This name can be used with GatewayFactory as an alias of the gateway class, to create new instances of this gateway.
`public`	# `getDefaultParameters( )` Define gateway parameters, in the following format: Define gateway parameters, in the following format: array( 'username' => '', // string variable 'testMode' => false, // boolean variable 'landingPage' => array('billing', 'login'), // enum variable, first item is default );
`public`	# `initialize( array $parameters = array() )` Initialize gateway with parameters Initialize gateway with parameters
`public array`	# `getParameters( )` Get all gateway parameters Get all gateway parameters Returns array

Magic methods summary
`public Omnipay\Common\Message\RequestInterface`	# `authorize( array $options = array()) (Optional method )` Authorize an amount on the customers card Authorize an amount on the customers card Parameters `$options` Returns `Omnipay\Common\Message\RequestInterface`
`public Omnipay\Common\Message\RequestInterface`	# `completeAuthorize( array $options = array()) (Optional method )` Handle return from off-site gateways after authorization Handle return from off-site gateways after authorization Parameters `$options` Returns `Omnipay\Common\Message\RequestInterface`
`public Omnipay\Common\Message\RequestInterface`	# `capture( array $options = array()) (Optional method )` Capture an amount you have previously authorized Capture an amount you have previously authorized Parameters `$options` Returns `Omnipay\Common\Message\RequestInterface`
`public Omnipay\Common\Message\RequestInterface`	# `purchase( array $options = array()) (Optional method )` Authorize and immediately capture an amount on the customers card Authorize and immediately capture an amount on the customers card Parameters `$options` Returns `Omnipay\Common\Message\RequestInterface`
`public Omnipay\Common\Message\RequestInterface`	# `completePurchase( array $options = array()) (Optional method )` Handle return from off-site gateways after purchase Handle return from off-site gateways after purchase Parameters `$options` Returns `Omnipay\Common\Message\RequestInterface`
`public Omnipay\Common\Message\RequestInterface`	# `refund( array $options = array()) (Optional method )` Refund an already processed transaction Refund an already processed transaction Parameters `$options` Returns `Omnipay\Common\Message\RequestInterface`
`public Omnipay\Common\Message\RequestInterface`	# `void( array $options = array()) (Optional method )` Generally can only be called up to 24 hours after submitting a transaction Generally can only be called up to 24 hours after submitting a transaction Parameters `$options` Returns `Omnipay\Common\Message\RequestInterface`
`public Omnipay\Common\Message\RequestInterface`	# `createCard( array $options = array()) (Optional method )` The returned response object includes a cardReference, which can be used for future transactions The returned response object includes a cardReference, which can be used for future transactions Parameters `$options` Returns `Omnipay\Common\Message\RequestInterface`
`public Omnipay\Common\Message\RequestInterface`	# `updateCard( array $options = array()) (Optional method )` Update a stored card Update a stored card Parameters `$options` Returns `Omnipay\Common\Message\RequestInterface`
`public Omnipay\Common\Message\RequestInterface`	# `deleteCard( array $options = array()) (Optional method )` Delete a stored card Delete a stored card Parameters `$options` Returns `Omnipay\Common\Message\RequestInterface`