File: //proc/self/cwd/wp-content/plugins/woocommerce-square/includes/Gateway/API/Requests/Payments.php
<?php
/**
* WooCommerce Square
*
* This source file is subject to the GNU General Public License v3.0
* that is bundled with this package in the file license.txt.
* It is also available through the world-wide-web at this URL:
* http://www.gnu.org/licenses/gpl-3.0.html GNU General Public License v3.0 or later
* If you did not receive a copy of the license and are unable to
* obtain it through the world-wide-web, please send an email
* to license@woocommerce.com so we can send you a copy immediately.
*
* DISCLAIMER
*
* Do not edit or add to this file if you wish to upgrade WooCommerce Square to newer
* versions in the future. If you wish to customize WooCommerce Square for your
* needs please refer to https://docs.woocommerce.com/document/woocommerce-square/
*
* @author WooCommerce
* @copyright Copyright: (c) 2019, Automattic, Inc.
* @license http://www.gnu.org/licenses/gpl-3.0.html GNU General Public License v3.0 or later
*/
namespace WooCommerce\Square\Gateway\API\Requests;
defined( 'ABSPATH' ) || exit;
use WooCommerce\Square\Framework\PaymentGateway\Payment_Gateway;
use WooCommerce\Square\Framework\Square_Helper;
use WooCommerce\Square\Utilities;
use WooCommerce\Square\Handlers\Order;
use WooCommerce\Square\Utilities\Money_Utility;
/**
* The Payments API request class.
*
* @since 2.2.0
*/
class Payments extends \WooCommerce\Square\API\Request {
/** @var string location ID */
protected $location_id;
/**
* Initializes a new payments request.
*
* @since 2.2.0
* @param string $location_id location ID
* @param \Square\SquareClient $api_client the API client
*/
public function __construct( $location_id, $api_client ) {
$this->location_id = $location_id;
$this->square_api = $api_client->getPaymentsApi();
}
/**
* Sets the data for an authorization/delayed capture.
*
* @since 2.2.0
* @param \WC_Order $order order object
*/
public function set_authorization_data( \WC_Order $order ) {
$this->set_charge_data( $order, false );
}
/**
* Sets the data for a charge.
*
* @since 2.2.0
*
* @param \WC_Order $order
* @param bool $capture whether to immediately capture the charge
*/
public function set_charge_data( \WC_Order $order, $capture = true, $is_cash_app_pay = false ) {
$this->square_api_method = 'createPayment';
$payment_total = isset( $order->payment->partial_total ) ? $order->payment->partial_total->other_gateway : $order->payment_total;
// Cash App Pay payment.
if ( $is_cash_app_pay ) {
$this->square_request = new \Square\Models\CreatePaymentRequest(
$order->payment->nonce->cash_app_pay,
wc_square()->get_idempotency_key( $order->unique_transaction_ref, false )
);
} else {
$this->square_request = new \Square\Models\CreatePaymentRequest(
! empty( $order->payment->token ) ? $order->payment->token : $order->payment->nonce->credit_card,
wc_square()->get_idempotency_key( $order->unique_transaction_ref, false )
);
}
$this->square_request->setReferenceId( $order->get_order_number() );
$this->square_request->setAmountMoney(
Utilities\Money_Utility::amount_to_money( $payment_total, $order->get_currency() )
);
if ( defined( 'WOOCOMMERCE_CHECKOUT' ) && WOOCOMMERCE_CHECKOUT ) {
$customer_details = new \Square\Models\CustomerDetails();
$customer_details->setCustomerInitiated( true );
$this->square_request->setCustomerDetails( $customer_details );
}
/**
* Filters the Square payment order note (legacy filter).
*
* @since 2.2.0
*
* @param string $description the order note (description)
* @param \WC_Order $order the order object
*/
$description = (string) apply_filters( 'wc_square_payment_order_note', $order->description, $order );
$this->square_request->setNote( Square_Helper::str_truncate( $description, 500 ) );
if ( ! empty( $order->square_customer_id ) ) {
$this->square_request->setCustomerId( $order->square_customer_id );
}
if ( isset( $order->payment->partial_total ) ) {
$this->square_request->setAutocomplete( false );
} else {
$this->square_request->setAutocomplete( $capture );
}
// Cash App Pay payment.
if ( $is_cash_app_pay ) {
// Payment nonce (from JS)
$this->square_request->setSourceId( $order->payment->nonce->cash_app_pay );
} else {
// payment token (card ID) or card nonce (from JS)
$this->square_request->setSourceId( ! empty( $order->payment->token ) ? $order->payment->token : $order->payment->nonce->credit_card );
// 3DS / SCA verification token (from JS)
if ( ! empty( $order->payment->verification_token ) && 'saved_card' !== $order->payment->verification_token ) {
$this->square_request->setVerificationToken( $order->payment->verification_token );
}
}
if ( ! empty( $this->location_id ) ) {
$this->square_request->setLocationId( $this->location_id );
}
$billing_address = new \Square\Models\Address();
$billing_address->setFirstName( $order->get_billing_first_name() );
$billing_address->setLastName( $order->get_billing_last_name() );
$billing_address->setAddressLine1( $order->get_billing_address_1() );
$billing_address->setAddressLine2( $order->get_billing_address_2() );
$billing_address->setLocality( $order->get_billing_city() );
$billing_address->setAdministrativeDistrictLevel1( $order->get_billing_state() );
$billing_address->setPostalCode( $order->get_billing_postcode() );
$billing_address->setCountry( $order->get_billing_country() );
$this->square_request->setBillingAddress( $billing_address );
if ( $order->get_shipping_address_1( 'edit' ) || $order->get_shipping_address_2( 'edit' ) ) {
$shipping_address = new \Square\Models\Address();
$shipping_address->setFirstName( $order->get_shipping_first_name() );
$shipping_address->setLastName( $order->get_shipping_last_name() );
$shipping_address->setAddressLine1( $order->get_shipping_address_1() );
$shipping_address->setAddressLine2( $order->get_shipping_address_2() );
$shipping_address->setLocality( $order->get_shipping_city() );
$shipping_address->setAdministrativeDistrictLevel1( $order->get_shipping_state() );
$shipping_address->setPostalCode( $order->get_shipping_postcode() );
$shipping_address->setCountry( $order->get_shipping_country() );
$this->square_request->setShippingAddress( $shipping_address );
}
$this->square_request->setBuyerEmailAddress( $order->get_billing_email() );
if ( ! empty( $order->square_order_id ) ) {
$this->square_request->setOrderId( $order->square_order_id );
}
$this->square_api_args = array(
$this->square_request,
);
}
/**
* Prepares data required to update the payment total.
*
* @since 3.7.0
*
* @param \WC_Order $order The WooCommerce order object.
* @param float $amount The new payment total.
*/
public function set_update_payment_data( \WC_Order $order, float $amount ) {
// Set the money object.
$amount_money = new \Square\Models\Money();
$charge_type = wc_square()->get_gateway( $order->get_payment_method() )->get_order_meta( $order, 'charge_type' );
$body = new \Square\Models\UpdatePaymentRequest( $order->unique_transaction_ref );
$transaction_id = '';
// Set the body for the updatePayment request.
if ( Payment_Gateway::CHARGE_TYPE_PARTIAL === $charge_type ) {
$gift_card_amount = Order::get_gift_card_total_charged_amount( $order );
$gift_card_amount = Money_Utility::amount_to_cents( $gift_card_amount, $order->get_currency() );
$transaction_id = wc_square()->get_gateway( $order->get_payment_method() )->get_order_meta( $order, 'trans_id' );
$amount_money->setAmount( $amount - $gift_card_amount );
} else {
$transaction_id = $order->get_transaction_id();
$amount_money->setAmount( $amount );
}
$amount_money->setCurrency( $order->get_currency() );
// Set the payments object.
$payment = new \Square\Models\Payment();
$payment->setAmountMoney( $amount_money );
$body->setPayment( $payment );
$this->square_api_method = 'updatePayment';
$this->square_api_args = array(
$transaction_id,
$body,
);
}
/**
* Sets the data for capturing a payment.
*
* @since 2.2.0
*
* @param \WC_Order $order order object
*/
public function set_capture_data( \WC_Order $order ) {
$this->square_api_method = 'completePayment';
$body = new \Square\Models\CompletePaymentRequest();
$body->setVersionToken( null );
$this->square_api_args = array( $order->capture->trans_id, $body );
}
/**
* Sets the data for capturing a gift card payment.
*
* @param \WC_Order $order order object
* @since 3.7.0
*/
public function set_gift_card_charge_data( \WC_Order $order ) {
$payment_total = isset( $order->payment->partial_total ) ? $order->payment->partial_total->gift_card : $order->payment_total;
$this->square_api_method = 'createPayment';
$this->square_request = new \Square\Models\CreatePaymentRequest(
$order->payment->nonce->gift_card,
wc_square()->get_idempotency_key( $order->unique_transaction_ref, false )
);
$this->square_request->setReferenceId( $order->get_order_number() );
$this->square_request->setAmountMoney(
Utilities\Money_Utility::amount_to_money( $payment_total, $order->get_currency() )
);
$should_authorize = wc_square()->get_gateway( $order->get_payment_method() )->perform_authorization( $order );
if ( isset( $order->payment->partial_total ) || $should_authorize ) {
$this->square_request->setAutocomplete( false );
}
/**
* Filters the Square payment order note (legacy filter).
*
* @since 2.2.0
*
* @param string $description the order note (description)
* @param \WC_Order $order the order object
*/
$description = (string) apply_filters( 'wc_square_payment_order_note', $order->description, $order );
$this->square_request->setNote( Square_Helper::str_truncate( $description, 500 ) );
if ( ! empty( $order->square_customer_id ) ) {
$this->square_request->setCustomerId( $order->square_customer_id );
}
if ( $order->square_order_id ) {
$this->square_request->setOrderId( $order->square_order_id );
}
if ( ! empty( $this->location_id ) ) {
$this->square_request->setLocationId( $this->location_id );
}
$this->square_api_args = array(
$this->square_request,
);
}
/**
* Sets the data for voiding/cancelling a payment.
*
* @since 2.2.0
*
* @param \WC_Order $order order object
*/
public function set_void_data( \WC_Order $order ) {
$this->square_api_method = 'cancelPayment';
$this->square_api_args = array( $order->refund->trans_id );
}
/**
* Sets the data for getting a Payment.
*
* @since 2.2.0
*
* @param string $payment_id payment ID
*/
public function set_get_payment_data( $payment_id ) {
$this->square_api_method = 'getPayment';
$this->square_api_args = array( $payment_id );
}
/**
* Sets the data for cancel a Payment.
*
* @since 4.6.0
*
* @param string $payment_id payment ID
*/
public function set_cancel_payment_data( $payment_id ) {
$this->square_api_method = 'cancelPayment';
$this->square_api_args = array( $payment_id );
}
/** Getter methods ************************************************************************************************/
/** Gets the location ID for this request.
*
* All requests in this type must have a location ID.
*
* @since 2.0.0
*
* @return string
*/
protected function get_location_id() {
return $this->location_id;
}
}