OctopusDeploy release: 12.0.4

globalpayments · May 30, 2024 · 836cc93 · 836cc93
1 parent 683c89b
commit 836cc93
Show file tree

Hide file tree

Showing 25 changed files with 499 additions and 52 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,7 +4,13 @@
 
 # Changelog
 
-## Latest Version - v12.0.3 (05/23/24)
+## Latest Version - v12.0.4 (05/30/24)
+### Enhancements:
+- [GP-ECOM] Added additional fee to a card transaction (surchargeamount).
+- [GP-API] Add mapping for "message_received " and "message_sent " on get a Single Action response
+- [GP-API] Add "Payers" feature
+
+## v12.0.3 (05/23/24)
 ### Enhancements:
 - [GP-API] Add "payer->email" property on 3DS "/initiate" request
 - [GP-API] Improvements on access token request

diff --git a/metadata.xml b/metadata.xml
@@ -1,3 +1,3 @@
 <xml>
-  <releaseNumber>12.0.3</releaseNumber>
+  <releaseNumber>12.0.4</releaseNumber>
 </xml>
diff --git a/src/Builders/AuthorizationBuilder.php b/src/Builders/AuthorizationBuilder.php
@@ -19,6 +19,7 @@
 use GlobalPayments\Api\Entities\Enums\{AddressType,
     AliasAction,
     BNPLShippingMethod,
+    CreditDebitIndicator,
     EmvFallbackCondition,
     EmvLastChipRead,
     InquiryType,
@@ -525,6 +526,9 @@ class AuthorizationBuilder extends TransactionBuilder
     /** @var MerchantCategory */
     public string $merchantCategory;
 
+    /** @var string|CreditDebitIndicator */
+    public string $creditDebitIndicator;
+
     /**
      * {@inheritdoc}
      *
@@ -1446,12 +1450,14 @@ public function withClerkId($clerkId)
 
     /**
      * @param float $value
+     * @param string|CreditDebitIndicator $creditDebitIndicator
      *
      * @return AuthorizationBuilder
      */
-    public function withSurchargeAmount($value)
+    public function withSurchargeAmount($value, $creditDebitIndicator = null)
     {
         $this->surchargeAmount = $value;
+        $this->creditDebitIndicator = $creditDebitIndicator;
 
         return $this;
     }

diff --git a/src/Builders/ManagementBuilder.php b/src/Builders/ManagementBuilder.php
@@ -5,6 +5,7 @@
 use GlobalPayments\Api\Entities\{DccRateData, FundsData, LodgingData, Transaction};
 use GlobalPayments\Api\Entities\Enums\{
     CommercialIndicator,
+    CreditDebitIndicator,
     PaymentMethodType,
     PaymentMethodUsageMode,
     TaxType,
@@ -211,6 +212,11 @@ class ManagementBuilder extends TransactionBuilder
     /** @var FundsData */
     public $fundsData;
 
+    public float $surchargeAmount;
+
+    /** @var string|CreditDebitIndicator */
+    public string $creditDebitIndicator;
+
     /**
      * {@inheritdoc}
      *
@@ -755,4 +761,18 @@ public function withFundsData(FundsData $fundsData)
 
         return $this;
     }
+
+    /**
+     * @param float $value
+     * @param string|CreditDebitIndicator $creditDebitIndicator
+     *
+     * @return ManagementBuilder
+     */
+    public function withSurchargeAmount($value, $creditDebitIndicator = null)
+    {
+        $this->surchargeAmount = $value;
+        $this->creditDebitIndicator = $creditDebitIndicator;
+
+        return $this;
+    }
 }
diff --git a/src/Builders/RequestBuilder/GpApi/GpApiAuthorizationRequestBuilder.php b/src/Builders/RequestBuilder/GpApi/GpApiAuthorizationRequestBuilder.php
@@ -100,9 +100,9 @@ public function buildRequest(BaseBuilder $builder, $config)
                     $requestData = [];
                     $requestData['account_name'] = $config->accessTokenInfo->tokenizationAccountName;
                     $requestData['account_id'] = $config->accessTokenInfo->tokenizationAccountID;
-                    $requestData['name'] = $builder->description ? $builder->description : "";
-                    $requestData['reference'] = $builder->clientTransactionId ?
-                        $builder->clientTransactionId : GenerationUtils::generateOrderId();
+                    $requestData['name'] = $builder->description ?: "";
+                    $requestData['payer'] = ['id' => $builder->customerId ?: ""];
+                    $requestData['reference'] = $builder->clientTransactionId ?: GenerationUtils::generateOrderId();
                     $requestData['usage_mode'] = $builder->paymentMethodUsageMode;
                     $requestData['fingerprint_mode'] =
                         (!empty($builder->customerData) & !empty($builder->customerData->deviceFingerPrint) ?
@@ -311,8 +311,9 @@ private function setRequestStoredCredentials(StoredCredential $storedCredential,
      */
     private function setPayerInformation($builder)
     {
-        $payer['reference'] = !empty($builder->customerId) ?
+        $payer['id'] = !empty($builder->customerId) ?
             $builder->customerId : (!empty($builder->customerData) ? $builder->customerData->id : null);
+        $payer['reference'] = !empty($builder->customerData) ? $builder->customerData->key : null;
         switch (get_class($builder->paymentMethod)) {
             case AlternativePaymentMethod::class:
                 $payer['home_phone'] = [

diff --git a/src/Builders/RequestBuilder/GpApi/GpApiRecurringRequestBuilder.php b/src/Builders/RequestBuilder/GpApi/GpApiRecurringRequestBuilder.php
@@ -0,0 +1,85 @@
+<?php
+
+namespace GlobalPayments\Api\Builders\RequestBuilder\GpApi;
+
+use GlobalPayments\Api\Builders\BaseBuilder;
+use GlobalPayments\Api\Builders\RecurringBuilder;
+use GlobalPayments\Api\Entities\Customer;
+use GlobalPayments\Api\Entities\Enums\TransactionType;
+use GlobalPayments\Api\Entities\GpApi\GpApiRequest;
+use GlobalPayments\Api\Entities\IRequestBuilder;
+use GlobalPayments\Api\Entities\Request;
+use GlobalPayments\Api\ServiceConfigs\Gateways\GpApiConfig;
+
+class GpApiRecurringRequestBuilder implements IRequestBuilder
+{
+    private $builder;
+    /***
+     * @param RecurringBuilder $builder
+     *
+     * @return bool
+     */
+    public static function canProcess($builder = null)
+    {
+        if ($builder instanceof RecurringBuilder) {
+            return true;
+        }
+
+        return false;
+    }
+
+    /**
+     * @param BaseBuilder $builder
+     * @param GpApiConfig $config
+     *
+     * @return Request
+     */
+    public function buildRequest(BaseBuilder $builder, $config)
+    {
+        /** @var RecurringBuilder $builder */
+        $this->builder = $builder;
+        $requestData = [];
+        /**
+         * @var RecurringBuilder $builder
+         */
+        switch ($builder->transactionType) {
+            case TransactionType::CREATE:
+                $endpoint = GpApiRequest::PAYERS_ENDPOINT;
+                $verb = 'POST';
+                if ($builder->entity instanceof Customer) {
+                    $this->preparePayerRequest($requestData);
+                }
+                break;
+            case TransactionType::EDIT:
+                $endpoint = GpApiRequest::PAYERS_ENDPOINT . '/' . $this->builder->entity->id;
+                $verb = 'PATCH';
+                if ($builder->entity instanceof Customer) {
+                    $this->preparePayerRequest($requestData);
+                }
+                break;
+        }
+        return new GpApiRequest($endpoint, $verb, $requestData);
+    }
+
+    private function preparePayerRequest(array &$requestData)
+    {
+        /** @var Customer $customer */
+        $customer = $this->builder->entity;
+        $requestData['first_name'] = $customer->firstName;
+        $requestData['last_name'] = $customer->lastName;
+        $requestData['reference'] = $customer->key;
+        if (!empty($customer->paymentMethods)) {
+            foreach ($customer->paymentMethods as $index => $paymentMethod) {
+                $requestData['payment_methods'][] =  [
+                    'id' => $index,
+                    'default' =>  $index === array_key_first($customer->paymentMethods) ? 'YES' : 'NO',
+                ];
+            }
+        }
+    }
+
+    public function buildRequestFromJson($jsonRequest, $config)
+    {
+        // TODO: Implement buildRequestFromJson() method.
+    }
+}
diff --git a/src/Builders/RequestBuilder/GpEcom/GpEcomAuthorizationRequestBuilder.php b/src/Builders/RequestBuilder/GpEcom/GpEcomAuthorizationRequestBuilder.php
@@ -95,7 +95,13 @@ public function buildRequest(BaseBuilder $builder, $config)
         }
 
         $request->appendChild($xml->createElement("orderid", $orderId));
-
+        if (isset($builder->surchargeAmount)) {
+            $surchargeAmount = $xml->createElement("surchargeamount",  preg_replace('/[^0-9]/', '', sprintf('%01.2f', $builder->surchargeAmount)));
+            if (!empty($builder->creditDebitIndicator)) {
+                $surchargeAmount->setAttribute("type", strtolower($builder->creditDebitIndicator));
+            }
+            $request->appendChild($surchargeAmount);
+        }
         // For Fraud Decision Manager
         if (!empty($builder->customerData)) {
             $customerValue = $builder->customerData;

diff --git a/src/Builders/RequestBuilder/GpEcom/GpEcomManagementRequestBuilder.php b/src/Builders/RequestBuilder/GpEcom/GpEcomManagementRequestBuilder.php
@@ -65,6 +65,13 @@ public function buildRequest(BaseBuilder $builder, $config)
         }
 
         $request->appendChild($xml->createElement("orderid", $orderId));
+        if (isset($builder->surchargeAmount)) {
+            $surchargeAmount = $xml->createElement("surchargeamount", preg_replace('/[^0-9]/', '', sprintf('%01.2f', $builder->surchargeAmount)));
+            if (!empty($builder->creditDebitIndicator)) {
+                $surchargeAmount->setAttribute("type", strtolower($builder->creditDebitIndicator));
+            }
+            $request->appendChild($surchargeAmount);
+        }
         $request->appendChild($xml->createElement("pasref", $builder->transactionId ?? ''));
 
         // rebate hash

diff --git a/src/Builders/RequestBuilder/RequestBuilderFactory.php b/src/Builders/RequestBuilder/RequestBuilderFactory.php
@@ -3,13 +3,16 @@
 namespace GlobalPayments\Api\Builders\RequestBuilder;
 
 use GlobalPayments\Api\Builders\BaseBuilder;
-use GlobalPayments\Api\Builders\RequestBuilder\GpApi\{GpApiAuthorizationRequestBuilder,
+use GlobalPayments\Api\Builders\RequestBuilder\GpApi\{
+    GpApiAuthorizationRequestBuilder,
     GpApiFileProcessingRequestBuilder,
     GpApiManagementRequestBuilder,
     GpApiMiCRequestBuilder,
     GpApiPayFacRequestBuilder,
+    GpApiRecurringRequestBuilder,
     GpApiReportRequestBuilder,
-    GpApiSecureRequestBuilder};
+    GpApiSecureRequestBuilder
+};
 use GlobalPayments\Api\Builders\RequestBuilder\GpEcom\{
     GpEcomAuthorizationRequestBuilder,
     GpEcomManagementRequestBuilder,
@@ -40,7 +43,8 @@ class RequestBuilderFactory
             GpApiSecureRequestBuilder::class,
             GpApiPayFacRequestBuilder::class,
             GpApiMiCRequestBuilder::class,
-            GpApiFileProcessingRequestBuilder::class
+            GpApiFileProcessingRequestBuilder::class,
+            GpApiRecurringRequestBuilder::class,
         ],
         GatewayProvider::TRANSACTION_API => [
             TransactionApiReportRequestBuilder::class,

diff --git a/src/Entities/Customer.php b/src/Entities/Customer.php
@@ -144,6 +144,8 @@ class Customer extends RecurringEntity
     /** @var array<CustomerDocument> */
     public $documents = [];
 
+    public array $paymentMethods = [];
+
     /**
      * Adds a payment method to the customer
      *
@@ -166,6 +168,7 @@ public function addPaymentMethod($paymentId, IPaymentMethod $paymentMethod, ?Sto
         $payment->id = $paymentId;
         $payment->nameOnAccount = $nameOnAccount;
         $payment->storedCredential = $storedCredential;
+        $this->paymentMethods[$paymentId] = $paymentMethod;
         return $payment;
     }
 }
diff --git a/src/Entities/Enums/UserType.php b/src/Entities/Enums/UserType.php
@@ -7,4 +7,5 @@
 class UserType extends Enum
 {
     const MERCHANT = 'MERCHANT';
+    const PAYER = 'PAYER';
 }
diff --git a/src/Entities/GpApi/GpApiRequest.php b/src/Entities/GpApi/GpApiRequest.php
@@ -25,4 +25,5 @@ class GpApiRequest extends Request
     const TRANSFER_ENDPOINT = '/transfers';
     const DEVICE_ENDPOINT = '/devices';
     const FILE_PROCESSING = '/files';
+    const PAYERS_ENDPOINT = '/payers';
 }
diff --git a/src/Entities/Reporting/ActionSummary.php b/src/Entities/Reporting/ActionSummary.php
@@ -75,4 +75,7 @@ class ActionSummary
      * @var string
      */
     public $accountId;
+
+    public ?string $rawRequest = null;
+    public ?string $rawResponse = null;
 }
diff --git a/src/Gateways/GpApiConnector.php b/src/Gateways/GpApiConnector.php
@@ -8,6 +8,7 @@
 use GlobalPayments\Api\Builders\FraudBuilder;
 use GlobalPayments\Api\Builders\ManagementBuilder;
 use GlobalPayments\Api\Builders\PayFacBuilder;
+use GlobalPayments\Api\Builders\RecurringBuilder;
 use GlobalPayments\Api\Builders\ReportBuilder;
 use GlobalPayments\Api\Builders\RequestBuilder\GpApi\GpApiMiCRequestBuilder;
 use GlobalPayments\Api\Builders\RequestBuilder\RequestBuilderFactory;
@@ -224,6 +225,16 @@ public function processFileUpload(FileProcessingBuilder $builder) : FileProcesso
         return GpApiMapping::mapFileProcessingResponse($response);
     }
 
+    public function processRecurring(RecurringBuilder $builder)
+    {
+        if (empty($this->accessToken)) {
+            $this->signIn();
+        }
+        $response = $this->executeProcess($builder);
+
+        return GpApiMapping::mapRecurringEntity($response, $builder->entity);
+    }
+
     private function executeProcess(BaseBuilder $builder)
     {
         $processFactory = new RequestBuilderFactory();

diff --git a/src/Mapping/GpApiMapping.php b/src/Mapping/GpApiMapping.php
@@ -10,6 +10,7 @@
 use GlobalPayments\Api\Entities\BNPLResponse;
 use GlobalPayments\Api\Entities\Card;
 use GlobalPayments\Api\Entities\CardIssuerResponse;
+use GlobalPayments\Api\Entities\Customer;
 use GlobalPayments\Api\Entities\DisputeDocument;
 use GlobalPayments\Api\Entities\DccRateData;
 use GlobalPayments\Api\Entities\Document;
@@ -41,6 +42,7 @@
 use GlobalPayments\Api\Entities\Person;
 use GlobalPayments\Api\Entities\PersonList;
 use GlobalPayments\Api\Entities\PhoneNumber;
+use GlobalPayments\Api\Entities\RecurringEntity;
 use GlobalPayments\Api\Entities\Reporting\ActionSummary;
 use GlobalPayments\Api\Entities\Reporting\DepositSummary;
 use GlobalPayments\Api\Entities\Reporting\DisputeSummary;
@@ -700,7 +702,8 @@ public static function mapActionsSummary($response)
         $summary->merchantName = !empty($response->merchant_name) ? $response->merchant_name : null;
         $summary->accountName = !empty($response->account_name) ? $response->account_name : null;
         $summary->accountId = !empty($response->account_id) ? $response->account_id : null;
-
+        $summary->rawRequest = $response->message_received ?? null;
+        $summary->rawResponse = $response->message_sent ?? null;
         return $summary;
     }
 
@@ -1346,4 +1349,22 @@ private static function mapSystemResponse(TransactionSummary|DepositSummary &$su
         $summary->merchantName = $system->name ?? null;
         $summary->merchantDbaName = $system->dba ?? null;
     }
+
+    public static function mapRecurringEntity($response,RecurringEntity $recurringEntity) : RecurringEntity
+    {
+        switch (get_class($recurringEntity)) {
+            case Customer::class:
+                $payer = $recurringEntity;
+                $payer->id = $response->id;
+                if (!empty($response->payment_methods)) {
+                    $payer->paymentMethods = [];
+                    foreach ($response->payment_methods as $paymentMethod) {
+                        $payer->paymentMethods[] = $paymentMethod;
+                    }
+                }
+                return $payer;
+            default:
+                break;
+        }
+    }
 }
diff --git a/src/ServiceConfigs/Gateways/GpApiConfig.php b/src/ServiceConfigs/Gateways/GpApiConfig.php
@@ -118,6 +118,7 @@ public function configureContainer(ConfiguredServices $services)
         $services->reportingService = $gateway;
         $services->fraudService = $gateway;
         $services->fileProcessingService = $gateway;
+        $services->recurringConnector = $gateway;
 
         $services->setOpenBankingProvider($gateway);
         $services->setPayFacProvider($gateway);