OctopusDeploy release: 14.0.1

Author: securesubmit-buildmaster

CHANGELOG.md

@@ -3,7 +3,11 @@
 </a>
 
 # Changelog
-## Latest Version v14.0.0 (11/06/25)
+## Latest Version v14.0.1 (11/13/25)
+### Enhancements:
+- [GPAPI] Added ContractReference field in Stored Credential
+
+## v14.0.0 (11/06/25)
 ### Enhancements:
 - [Rebrand] Replace Heartland branding with Global Payments
 

metadata.xml

@@ -1,3 +1,3 @@
 <xml>
-  <releaseNumber>14.0.0</releaseNumber>
+  <releaseNumber>14.0.1</releaseNumber>
 </xml>

src/Builders/AuthorizationBuilder.php

@@ -271,6 +271,14 @@ class AuthorizationBuilder extends TransactionBuilder
      */
     public $invoiceNumber;
 
+    /**
+     * Request contract reference
+     *
+     * @internal
+     * @var string
+     */
+    public $contractReference;
+
     /**
      * Request should request Level II
      *

src/Builders/RequestBuilder/GpApi/GpApiAuthorizationRequestBuilder.php

@@ -448,7 +448,7 @@ private function generateVerificationRequest(AuthorizationBuilder $builder, GpAp
         $requestBody['country'] = $config->country;
         $requestBody['payment_method'] = $this->createPaymentMethodParam($builder, $config);
         if (!empty($builder->storedCredential)) {
-            $this->setRequestStoredCredentials($builder->storedCredential, $requestBody);
+            $this->setRequestStoredCredentials($builder->storedCredential, $requestBody, $builder);
         }
 
         return $requestBody;
@@ -512,7 +512,7 @@ private function createFromAuthorizationBuilder($builder, GpApiConfig $config)
             $this->setNotificationUrls($requestBody);
         }
         if (!empty($builder->storedCredential)) {
-            $this->setRequestStoredCredentials($builder->storedCredential, $requestBody);
+            $this->setRequestStoredCredentials($builder->storedCredential, $requestBody, $builder, $config);
         }
 
         if (!empty($builder->dccRateData)) {
@@ -528,7 +528,7 @@ private function createFromAuthorizationBuilder($builder, GpApiConfig $config)
         return $requestBody;
     }
 
-    private function setRequestStoredCredentials(StoredCredential $storedCredential, &$request)
+    private function setRequestStoredCredentials(StoredCredential $storedCredential, &$request, $builder = null, $config = null)
     {
         $request['initiator'] = !empty($storedCredential->initiator) ?
             EnumMapping::mapStoredCredentialInitiator(GatewayProvider::GP_API, $storedCredential->initiator) : null;
@@ -537,11 +537,21 @@ private function setRequestStoredCredentials(StoredCredential $storedCredential,
             'reason' => !empty($storedCredential->reason) ? strtoupper((string) $storedCredential->reason) : null,
             'sequence' => !empty($storedCredential->sequence) ? strtoupper((string) $storedCredential->sequence) : null
         ];
+        
+        // Add contract reference if provided in StoredCredential and both currency is MXN and country is MX (Mexico)
+         if (
+            !empty($storedCredential->contract_reference)
+            && (!empty($builder->currency) && strtoupper($builder->currency) === 'MXN')
+            && (!empty($config->country) && strtoupper($config->country) === 'MX')
+        ) {
+            $request['stored_credential']['contract_reference'] = $storedCredential->contract_reference;
+        }
     }
 
     /**
      * Sets the information related to the payer
      *
+     * 
      * @param AuthorizationBuilder $builder
      * @return mixed
      */

src/Entities/StoredCredential.php

@@ -26,4 +26,9 @@ class StoredCredential
      * @var string
      */
     public $cardBrandTransactionId;
+
+    /**
+     * @var string
+     */
+    public $contract_reference;
 }

test/Integration/Gateways/GpApiConnector/GpApiInstallmentTest.php

@@ -95,19 +95,20 @@ public function setup(): void
         $this->storeCredentials->type = StoredCredentialType::INSTALLMENT;
         $this->storeCredentials->sequence = StoredCredentialSequence::SUBSEQUENT;
         $this->storeCredentials->reason = StoredCredentialReason::INCREMENTAL;
+        $this->storeCredentials->contract_reference = "testshraddha";
 
         $this->visaCard = new CreditCardData();
-        $this->visaCard->number = "4915669522406071";
-        $this->visaCard->expMonth = 04;
-        $this->visaCard->expYear = 2026;
-        $this->visaCard->cvn = "123";
+        $this->visaCard->number = "4395840190010011";
+        $this->visaCard->expMonth = 12;
+        $this->visaCard->expYear = 2027;
+        $this->visaCard->cvn = "840";
         $this->visaCard->cardPresent = false;
         $this->visaCard->readerPresent = false;
 
         $this->masterCard = new CreditCardData();
-        $this->masterCard->number = "5579083004810368";
+        $this->masterCard->number = "5120350100064537";
         $this->masterCard->expMonth = 12;
-        $this->masterCard->expYear = 2026;
+        $this->masterCard->expYear = 2027;
         $this->masterCard->cvn = "123";
         $this->masterCard->cardPresent = false;
         $this->masterCard->readerPresent = false;
@@ -274,6 +275,40 @@ public function testReportTransactionsDetailForInstallment()
     }
 
     /** END Reporting Test Cases **/
+
+    /** START Contract Reference Test Cases **/
+
+    public function testContractReference_Visa_Sandbox()
+    {
+        ServicesContainer::configureService($this->setUpConfigSandbox());
+        $response = $this->visaCard->charge($this->amount)
+            ->withCurrency($this->currency)
+            ->withAddress($this->address)
+            ->withInstallment($this->installment)
+            ->withStoredCredential($this->storeCredentials)
+            ->withAllowDuplicates(true)
+            ->execute();
+
+            $this->assertNotNull($response);
+            $this->assertEquals('SUCCESS', $response->responseCode);
+    }
+
+    public function testContractReference_MC_Sandbox()
+    {
+        ServicesContainer::configureService($this->setUpConfigSandbox());
+        $response = $this->masterCard->charge($this->amount)
+            ->withCurrency($this->currency)
+            ->withAddress($this->address)
+            ->withInstallment($this->installment)
+            ->withStoredCredential($this->storeCredentials)
+            ->withAllowDuplicates(true)
+            ->execute();
+
+            $this->assertNotNull($response);
+            $this->assertEquals('SUCCESS', $response->responseCode);
+    }
+
+    /** END Contract Reference Test Cases **/
 
     public function setUpConfig(): GpApiConfig
     {
@@ -291,4 +326,19 @@ public function setUpConfig(): GpApiConfig
         $config->requestLogger = new RequestConsoleLogger();
         return $config;
     }
+
+    public function setUpConfigSandbox(): GpApiConfig
+    {
+        $config = BaseGpApiTestConfig::gpApiSetupConfig(Channel::CardNotPresent);
+        $config->country = 'MX';
+        $config->appId = '4gPqnGBkppGYvoE5UX9EWQlotTxGUDbs';
+        $config->appKey = 'FQyJA5VuEQfcji2M';
+        $config->serviceUrl = 'https://apis.sandbox.globalpay.com/ucp';
+        $config->accessTokenInfo = new AccessTokenInfo();
+        $config->accessTokenInfo->riskAssessmentAccountName = 'transaction_processing';
+        $config->accessTokenInfo->transactionProcessingAccountName = 'transaction_processing';
+       
+        $config->requestLogger = new RequestConsoleLogger();
+        return $config;
+    }
 }