Payment_Gateway_API_Response.php
3 years ago
Payment_Gateway_Api.php
2 years ago
Payment_Gateway_Api_Authorization_Response.php
2 years ago
Payment_Gateway_Api_Create_Payment_Token_Response.php
3 years ago
Payment_Gateway_Api_Customer_Response.php
3 years ago
Payment_Gateway_Api_Get_Tokenized_Payment_Methods_Response.php
3 years ago
Payment_Gateway_Api_Response_Message_Helper.php
3 years ago
Payment_Gateway_API_Response.php
110 lines
| 1 | <?php |
| 2 | /** |
| 3 | * WooCommerce Payment Gateway Framework |
| 4 | * |
| 5 | * This source file is subject to the GNU General Public License v3.0 |
| 6 | * that is bundled with this package in the file license.txt. |
| 7 | * It is also available through the world-wide-web at this URL: |
| 8 | * http://www.gnu.org/licenses/gpl-3.0.html GNU General Public License v3.0 or later |
| 9 | * If you did not receive a copy of the license and are unable to |
| 10 | * obtain it through the world-wide-web, please send an email |
| 11 | * to license@skyverge.com so we can send you a copy immediately. |
| 12 | * |
| 13 | * @since 3.0.0 |
| 14 | * @author WooCommerce / SkyVerge |
| 15 | * @copyright Copyright (c) 2013-2019, SkyVerge, Inc. |
| 16 | * @license http://www.gnu.org/licenses/gpl-3.0.html GNU General Public License v3.0 or later |
| 17 | * |
| 18 | * Modified by WooCommerce on 15 December 2021. |
| 19 | */ |
| 20 | |
| 21 | namespace WooCommerce\Square\Framework\PaymentGateway\Api; |
| 22 | use WooCommerce\Square\Framework\Api\API_Response; |
| 23 | |
| 24 | defined( 'ABSPATH' ) or exit; |
| 25 | |
| 26 | /** |
| 27 | * WooCommerce Direct Payment Gateway API Response |
| 28 | */ |
| 29 | interface Payment_Gateway_API_Response extends API_Response { |
| 30 | |
| 31 | /** |
| 32 | * Checks if the transaction was successful. |
| 33 | * |
| 34 | * @since 3.0.0 |
| 35 | * |
| 36 | * @return bool true if approved, false otherwise |
| 37 | */ |
| 38 | public function transaction_approved(); |
| 39 | |
| 40 | |
| 41 | /** |
| 42 | * Returns true if the transaction was held, for instance due to AVS/CSC |
| 43 | * Fraud Settings. This indicates that the transaction was successful, but |
| 44 | * did not pass a fraud check and should be reviewed. |
| 45 | * |
| 46 | * @since 3.0.0 |
| 47 | * |
| 48 | * @return bool true if the transaction was held, false otherwise |
| 49 | */ |
| 50 | public function transaction_held(); |
| 51 | |
| 52 | |
| 53 | /** |
| 54 | * Gets the response status message, or null if there is no status message |
| 55 | * associated with this transaction. |
| 56 | * |
| 57 | * @since 3.0.0 |
| 58 | * |
| 59 | * @return string status message |
| 60 | */ |
| 61 | public function get_status_message(); |
| 62 | |
| 63 | |
| 64 | /** |
| 65 | * Gets the response status code, or null if there is no status code |
| 66 | * associated with this transaction. |
| 67 | * |
| 68 | * @since 3.0.0 |
| 69 | * |
| 70 | * @return string status code |
| 71 | */ |
| 72 | public function get_status_code(); |
| 73 | |
| 74 | |
| 75 | /** |
| 76 | * Gets the response transaction id, or null if there is no transaction id |
| 77 | * associated with this transaction. |
| 78 | * |
| 79 | * @since 3.0.0 |
| 80 | * |
| 81 | * @return string transaction id |
| 82 | */ |
| 83 | public function get_transaction_id(); |
| 84 | |
| 85 | |
| 86 | /** |
| 87 | * Gets the payment type: 'credit-card', 'echeck', etc... |
| 88 | * |
| 89 | * @since 3.0.0 |
| 90 | * |
| 91 | * @return string |
| 92 | */ |
| 93 | public function get_payment_type(); |
| 94 | |
| 95 | |
| 96 | /** |
| 97 | * Returns a message appropriate for a frontend user. This should be used |
| 98 | * to provide enough information to a user to allow them to resolve an |
| 99 | * issue on their own, but not enough to help nefarious folks fishing for |
| 100 | * info. |
| 101 | * |
| 102 | * @see Payment_Gateway_API_Response_Message_Helper |
| 103 | * |
| 104 | * @since 3.0.0 |
| 105 | * |
| 106 | * @return string user message, if there is one |
| 107 | */ |
| 108 | public function get_user_message(); |
| 109 | } |
| 110 |