MethodInterface.php

Go to the documentation of this file.

<?php
namespace Magento\Payment\Model;

use Magento\Framework\DataObject;
use Magento\Quote\Api\Data\CartInterface;

interface 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';

    public function getCode();

    public function getFormBlockType();

    public function getTitle();

    public function setStore($storeId);

    public function getStore();

    public function canOrder();

    public function canAuthorize();

    public function canCapture();

    public function canCapturePartial();

    public function canCaptureOnce();

    public function canRefund();

    public function canRefundPartialPerInvoice();

    public function canVoid();

    public function canUseInternal();

    public function canUseCheckout();

    public function canEdit();

    public function canFetchTransactionInfo();

    public function fetchTransactionInfo(InfoInterface $payment, $transactionId);

    public function isGateway();

    public function isOffline();

    public function isInitializeNeeded();

    public function canUseForCountry($country);

    public function canUseForCurrency($currencyCode);

    public function getInfoBlockType();

    public function getInfoInstance();

    public function setInfoInstance(InfoInterface $info);

    public function validate();

    public function order(\Magento\Payment\Model\InfoInterface $payment, $amount);

    public function authorize(\Magento\Payment\Model\InfoInterface $payment, $amount);

    public function capture(\Magento\Payment\Model\InfoInterface $payment, $amount);

    public function refund(\Magento\Payment\Model\InfoInterface $payment, $amount);

    public function cancel(\Magento\Payment\Model\InfoInterface $payment);

    public function void(\Magento\Payment\Model\InfoInterface $payment);

    public function canReviewPayment();

    public function acceptPayment(InfoInterface $payment);

    public function denyPayment(InfoInterface $payment);

    public function getConfigData($field, $storeId = null);

    public function assignData(DataObject $data);

    public function isAvailable(CartInterface $quote = null);

    public function isActive($storeId = null);

    public function initialize($paymentAction, $stateObject);

    public function getConfigPaymentAction();
}