Magento 2 Documentation  2.3
Documentation for Magento 2 CMS v2.3 (December 2018)
Public Member Functions | Data Fields
VaultPaymentInterface Interface Reference
Inheritance diagram for VaultPaymentInterface:
MethodInterface Vault

Public Member Functions

 getProviderCode ()
 
- Public Member Functions inherited from MethodInterface
 getCode ()
 
 getFormBlockType ()
 
 getTitle ()
 
 setStore ($storeId)
 
 getStore ()
 
 canOrder ()
 
 canAuthorize ()
 
 canCapture ()
 
 canCapturePartial ()
 
 canCaptureOnce ()
 
 canRefund ()
 
 canRefundPartialPerInvoice ()
 
 canVoid ()
 
 canUseInternal ()
 
 canUseCheckout ()
 
 canEdit ()
 
 canFetchTransactionInfo ()
 
 fetchTransactionInfo (InfoInterface $payment, $transactionId)
 
 isGateway ()
 
 isOffline ()
 
 isInitializeNeeded ()
 
 canUseForCountry ($country)
 
 canUseForCurrency ($currencyCode)
 
 getInfoBlockType ()
 
 getInfoInstance ()
 
 setInfoInstance (InfoInterface $info)
 
 validate ()
 
 order (\Magento\Payment\Model\InfoInterface $payment, $amount)
 
 authorize (\Magento\Payment\Model\InfoInterface $payment, $amount)
 
 capture (\Magento\Payment\Model\InfoInterface $payment, $amount)
 
 refund (\Magento\Payment\Model\InfoInterface $payment, $amount)
 
 cancel (\Magento\Payment\Model\InfoInterface $payment)
 
 void (\Magento\Payment\Model\InfoInterface $payment)
 
 canReviewPayment ()
 
 acceptPayment (InfoInterface $payment)
 
 denyPayment (InfoInterface $payment)
 
 getConfigData ($field, $storeId=null)
 
 assignData (DataObject $data)
 
 isAvailable (CartInterface $quote=null)
 
 isActive ($storeId=null)
 
 initialize ($paymentAction, $stateObject)
 
 getConfigPaymentAction ()
 

Data Fields

const VAULT_AUTHORIZE_COMMAND = 'vault_authorize'
 
const VAULT_SALE_COMMAND = 'vault_sale'
 
const CAN_AUTHORIZE = 'can_authorize_vault'
 
const CAN_CAPTURE = 'can_capture_vault'
 
- Data Fields inherited from MethodInterface
const ACTION_ORDER = 'order'
 
const ACTION_AUTHORIZE = 'authorize'
 
const ACTION_AUTHORIZE_CAPTURE = 'authorize_capture'
 
const CHECK_USE_FOR_COUNTRY = 'country'
 
const CHECK_USE_FOR_CURRENCY = 'currency'
 
const CHECK_USE_CHECKOUT = 'checkout'
 
const CHECK_USE_INTERNAL = 'internal'
 
const CHECK_ORDER_TOTAL_MIN_MAX = 'total'
 
const CHECK_ZERO_TOTAL = 'zero_total'
 
const GROUP_OFFLINE = 'offline'
 

Detailed Description

Interface VaultPaymentInterface @api

Since
100.1.0

Definition at line 15 of file VaultPaymentInterface.php.

Member Function Documentation

◆ getProviderCode()

getProviderCode ( )
Returns
string|null
Since
100.1.0

Implemented in Vault.

Field Documentation

◆ CAN_AUTHORIZE

const CAN_AUTHORIZE = 'can_authorize_vault'

Definition at line 21 of file VaultPaymentInterface.php.

◆ CAN_CAPTURE

const CAN_CAPTURE = 'can_capture_vault'

Definition at line 23 of file VaultPaymentInterface.php.

◆ VAULT_AUTHORIZE_COMMAND

const VAULT_AUTHORIZE_COMMAND = 'vault_authorize'

Definition at line 17 of file VaultPaymentInterface.php.

◆ VAULT_SALE_COMMAND

const VAULT_SALE_COMMAND = 'vault_sale'

Definition at line 19 of file VaultPaymentInterface.php.


The documentation for this interface was generated from the following file: