feature/INT-1724 - CashApp payment method integration

lib/Checkout/Payments/Setups/Common/Customer/Customer.php

@@ -4,30 +4,66 @@
 
 use Checkout\Common\Phone;
 
+/**
+ * The customer's details.
+ */
 class Customer
 {
     /**
+     * Details of the customer's email.
+     * [Optional]
      * @var Email
      */
     public $email;
 
     /**
+     * The customer's full name.
+     * [Optional]
+     * max 100 characters
      * @var string
      */
     public $name;
 
     /**
+     * The customer's phone number.
+     * [Optional]
      * @var Phone
      */
     public $phone;
 
     /**
+     * Details of the customer's device.
+     * [Optional]
      * @var Device
      */
     public $device;
 
     /**
+     * Details of the account the customer holds with the merchant.
+     * [Optional]
      * @var MerchantAccount
      */
     public $merchant_account;
+
+    /**
+     * The unique identifier of the customer.
+     * [Optional]
+     * @var string
+     */
+    public $id;
+
+    /**
+     * The two-letter ISO country code of the customer for this payment.
+     * [Optional]
+     * min 2 characters, max 2 characters
+     * @var string value of Country
+     */
+    public $country;
+
+    /**
+     * The customer's tax identification number.
+     * [Optional]
+     * @var string
+     */
+    public $tax_number;
 }

lib/Checkout/Payments/Setups/Common/Customer/Device.php

@@ -2,10 +2,52 @@
 
 namespace Checkout\Payments\Setups\Common\Customer;
 
+/**
+ * Details of the customer's device.
+ */
 class Device
 {
     /**
+     * The locale of the device.
+     * [Optional]
      * @var string
      */
     public $locale;
+
+    /**
+     * A unique identifier for the customer's device.
+     * [Optional]
+     * @var string
+     */
+    public $fingerprint;
+
+    /**
+     * The customer's device IPv4 address, used by some payment methods for risk and eligibility checks.
+     * [Optional]
+     * @var string
+     */
+    public $ipv4;
+
+    /**
+     * The customer's device IPv6 address, used by some payment methods for risk and eligibility checks.
+     * [Optional]
+     * @var string
+     */
+    public $ipv6;
+
+    /**
+     * The type of client the customer uses to initiate the payment. Required when using Cash App Pay.
+     * [Optional]
+     * Enum: "web" "mobile_web" "app"
+     * @var string value of DeviceClient
+     */
+    public $client;
+
+    /**
+     * The operating system of the customer's device.
+     * [Optional]
+     * Enum: "android" "ios"
+     * @var string value of DeviceOs
+     */
+    public $os;
 }

lib/Checkout/Payments/Setups/Common/Customer/DeviceClient.php

@@ -0,0 +1,27 @@
+<?php
+
+namespace Checkout\Payments\Setups\Common\Customer;
+
+/**
+ * The type of client the customer uses to initiate the payment.
+ */
+class DeviceClient
+{
+    /**
+     * A web browser on a desktop device.
+     * @var string
+     */
+    public static $web = "web";
+
+    /**
+     * A web browser on a mobile device.
+     * @var string
+     */
+    public static $mobile_web = "mobile_web";
+
+    /**
+     * A native mobile application.
+     * @var string
+     */
+    public static $app = "app";
+}

lib/Checkout/Payments/Setups/Common/Customer/DeviceOs.php

@@ -0,0 +1,21 @@
+<?php
+
+namespace Checkout\Payments\Setups\Common\Customer;
+
+/**
+ * The operating system of the customer's device.
+ */
+class DeviceOs
+{
+    /**
+     * Android.
+     * @var string
+     */
+    public static $android = "android";
+
+    /**
+     * iOS.
+     * @var string
+     */
+    public static $ios = "ios";
+}

lib/Checkout/Payments/Setups/Common/PaymentMethods/CashApp/CashApp.php

@@ -0,0 +1,51 @@
+<?php
+
+namespace Checkout\Payments\Setups\Common\PaymentMethods\CashApp;
+
+use Checkout\Payments\Setups\Common\PaymentMethods\Common\PaymentMethodBase;
+
+/**
+ * The Cash App payment method's details and configuration.
+ *
+ * Inherits status, flags and initialization from PaymentMethodBase. Send initialization and
+ * customer_profile_sharing; the remaining properties are returned by the API only. To authorize the
+ * payment, send the customer to the redirect URL returned in the action. The customer device client
+ * (customer.device.client) is required when using this payment method.
+ */
+class CashApp extends PaymentMethodBase
+{
+    /**
+     * Indicates whether the customer consents to share their Cash App customer profile with Checkout.com.
+     * [Optional]
+     * @var bool
+     */
+    public $customer_profile_sharing;
+
+    /**
+     * The customer's Cash App profile that they consented to share. Included in the response when
+     * customer_profile_sharing is enabled.
+     * Cash App releases this profile only once. It's present in the first successful response when you get
+     * the Payment Setup after the customer authorizes the payment. Every subsequent response omits it.
+     * [Optional]
+     * readOnly
+     * @var CashAppCustomerProfile
+     */
+    public $customer_profile;
+
+    /**
+     * A reference for the Cash App Pay transaction, returned by the provider.
+     * [Optional]
+     * readOnly
+     * max 80 characters
+     * @var string
+     */
+    public $reference;
+
+    /**
+     * The next available action for the payment method.
+     * [Optional]
+     * readOnly
+     * @var CashAppAction
+     */
+    public $action;
+}

lib/Checkout/Payments/Setups/Common/PaymentMethods/CashApp/CashAppAction.php

@@ -0,0 +1,27 @@
+<?php
+
+namespace Checkout\Payments\Setups\Common\PaymentMethods\CashApp;
+
+/**
+ * The next available action for the Cash App payment method (response only).
+ */
+class CashAppAction
+{
+    /**
+     * The type of action.
+     * [Optional]
+     * readOnly
+     * Enum: "redirect"
+     * @var string value of CashAppActionType
+     */
+    public $type;
+
+    /**
+     * The URL to redirect the customer to so they can authorize the payment with Cash App.
+     * [Optional]
+     * readOnly
+     * Format: uri
+     * @var string
+     */
+    public $redirect_url;
+}

lib/Checkout/Payments/Setups/Common/PaymentMethods/CashApp/CashAppActionType.php

@@ -0,0 +1,15 @@
+<?php
+
+namespace Checkout\Payments\Setups\Common\PaymentMethods\CashApp;
+
+/**
+ * The type of the Cash App payment method action.
+ */
+class CashAppActionType
+{
+    /**
+     * Redirect the customer to Cash App to authorize the payment.
+     * @var string
+     */
+    public static $redirect = "redirect";
+}

lib/Checkout/Payments/Setups/Common/PaymentMethods/CashApp/CashAppAddress.php

@@ -0,0 +1,77 @@
+<?php
+
+namespace Checkout\Payments\Setups\Common\PaymentMethods\CashApp;
+
+/**
+ * The address in a Cash App customer profile (response only).
+ *
+ * Uses Cash App's own key names (address_line_1, administrative_district_level_1), which differ from the
+ * Checkout.com Address (address_line1, city, state, zip). Do not replace it with the common Address.
+ */
+class CashAppAddress
+{
+    /**
+     * The first line of the address.
+     * [Optional]
+     * readOnly
+     * @var string
+     */
+    public $address_line_1;
+
+    /**
+     * The second line of the address.
+     * [Optional]
+     * readOnly
+     * @var string
+     */
+    public $address_line_2;
+
+    /**
+     * The third line of the address.
+     * [Optional]
+     * readOnly
+     * @var string
+     */
+    public $address_line_3;
+
+    /**
+     * The address locality, such as the city or town.
+     * [Optional]
+     * readOnly
+     * @var string
+     */
+    public $locality;
+
+    /**
+     * The address sublocality, such as the district or neighborhood.
+     * [Optional]
+     * readOnly
+     * @var string
+     */
+    public $sublocality;
+
+    /**
+     * The address's top-level administrative district, such as the state or province.
+     * [Optional]
+     * readOnly
+     * @var string
+     */
+    public $administrative_district_level_1;
+
+    /**
+     * The postal or zip code.
+     * [Optional]
+     * readOnly
+     * @var string
+     */
+    public $postal_code;
+
+    /**
+     * The address country, in ISO 3166-1 alpha-2 format.
+     * [Optional]
+     * readOnly
+     * max 2 characters
+     * @var string value of Country
+     */
+    public $country;
+}