Your IP : 216.73.216.220

Current Path : /home/rtorresani/www/vendor/magento/module-payment/Api/
Upload File :
Current File : //home/rtorresani/www/vendor/magento/module-payment/Api/PaymentVerificationInterface.php

<?php
/**
 * Copyright © Magento, Inc. All rights reserved.
 * See COPYING.txt for license details.
 */
namespace Magento\Payment\Api;

use Magento\Sales\Api\Data\OrderPaymentInterface;

/**
 * Payment provider codes verification interface.
 *
 * Custom payment methods might implement this interface to provide
 * specific mapping for payment methods, like AVS or CVV verification.
 * The payment methods can map payment method info from internal sources,
 * like additional information, to specific international codes.
 *
 * There are no default implementation of this interface, because code verification
 * depends on payment method integration specifics.
 *
 * @api
 * @since 100.2.0
 */
interface PaymentVerificationInterface
{
    /**
     * Gets payment provider verification code.
     * Throws an exception if provided payment method is different to verification implementation.
     *
     * @param OrderPaymentInterface $orderPayment
     * @return string
     * @throws \InvalidArgumentException
     * @since 100.2.0
     */
    public function getCode(OrderPaymentInterface $orderPayment);
}