Merge pull request #154 from CyberSource/release-march24

March Release 24

README.md

@@ -29,7 +29,7 @@ override the new secure-http default setting)*.
 {
   "require": {
     "php": ">=8.0.0", 
-    "cybersource/rest-client-php": "0.0.48"
+    "cybersource/rest-client-php": "0.0.49"
   }
 }
 ```

composer.json

@@ -1,6 +1,6 @@
 {
     "name": "cybersource/rest-client-php",
-    "version": "0.0.48",
+    "version": "0.0.49",
     "description": "Client SDK for CyberSource REST APIs",
     "keywords": [
         "cybersource", "payments", "ecommerce", "merchant", "merchants", "authorize", "visa", "payment", "payment-gateway", "payment-integration", "payment-module", "payment-processing", "payment-service", "payment-methods"

docs/Api/BillingAgreementsApi.md

@@ -4,17 +4,17 @@ All URIs are relative to *https://apitest.cybersource.com*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------
-[**billingAgreementsDeRegistration**](BillingAgreementsApi.md#billingAgreementsDeRegistration) | **PATCH** /pts/v2/billing-agreements/{id} | Standing Instruction Cancellation or Modification
+[**billingAgreementsDeRegistration**](BillingAgreementsApi.md#billingAgreementsDeRegistration) | **PATCH** /pts/v2/billing-agreements/{id} | Modify a Billing Agreement
 [**billingAgreementsIntimation**](BillingAgreementsApi.md#billingAgreementsIntimation) | **POST** /pts/v2/billing-agreements/{id}/intimations | Standing Instruction intimation
-[**billingAgreementsRegistration**](BillingAgreementsApi.md#billingAgreementsRegistration) | **POST** /pts/v2/billing-agreements | Standing Instruction completion registration
+[**billingAgreementsRegistration**](BillingAgreementsApi.md#billingAgreementsRegistration) | **POST** /pts/v2/billing-agreements | Create a Billing Agreement
 
 
 # **billingAgreementsDeRegistration**
-> \CyberSource\Model\PtsV2CreditsPost201Response1 billingAgreementsDeRegistration($modifyBillingAgreement, $id)
+> \CyberSource\Model\PtsV2ModifyBillingAgreementPost201Response billingAgreementsDeRegistration($modifyBillingAgreement, $id)
 
-Standing Instruction Cancellation or Modification
+Modify a Billing Agreement
 
-Standing Instruction with or without Token
+#### Standing Instruction: Standing Instruction with or without Token.  #### Revoke Mandate: When you revoke a mandate, any pending direct debits linked to that mandate are canceled. No notifications are sent. When you revoke a mandate with no pending direct debits, the Bacs scheme or customer's bank notify you of any subsequent direct debit events. When you revoke a mandate, you cannot send a direct debit request using the mandate ID. Customer payments cannot be made against a revoked mandate. You can revoke a mandate when the customer:   - Requests that you revoke the mandate.   - Closes their account with you. Possible revoke mandate status values -   - Revoked—the revoke mandate request was successfully processed.   - Failed—the revoke mandate request was not accepted.  #### Update Mandate: In most cases, the account details of an existing mandate cannot be updated in the Bacs schema, except by creating a new mandate. However, some very limited customer information, like name and address, can be updated to the mandate without needing to revoke it first  #### Mandate Status: After the customer signs the mandate, request that the mandate status service verify the mandate status. Possible mandate status values:   - Active—the mandate is successfully created. A direct debit can be sent for this mandate ID.   - Pending—a pending mandate means the mandate is not yet signed.   - Failed—the customer did not authenticate.   - Expired—the deadline to create the mandate passed.   - Revoked—the mandate is cancelled.  #### Paypal Billing Agreement:  A billing agreement is set up between PayPal and your customer. When you collect the details of a customer's billing agreement, you are able to bill that customer without requiring an authorization for each payment.  You can bill the customer at the same time you process their PayPal Express checkout order, which simplifies your business processes.
 
 ### Example
 ```php
@@ -43,7 +43,7 @@ Name | Type | Description  | Notes
 
 ### Return type
 
-[**\CyberSource\Model\PtsV2CreditsPost201Response1**](../Model/PtsV2CreditsPost201Response1.md)
+[**\CyberSource\Model\PtsV2ModifyBillingAgreementPost201Response**](../Model/PtsV2ModifyBillingAgreementPost201Response.md)
 
 ### Authorization
 
@@ -104,11 +104,11 @@ No authorization required
 [[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
 
 # **billingAgreementsRegistration**
-> \CyberSource\Model\PtsV2CreditsPost201Response1 billingAgreementsRegistration($createBillingAgreement)
+> \CyberSource\Model\PtsV2CreateBillingAgreementPost201Response billingAgreementsRegistration($createBillingAgreement)
 
-Standing Instruction completion registration
+Create a Billing Agreement
 
-Standing Instruction with or without Token. Transaction amount in case First payment is coming along with registration. Only 2 decimal places allowed
+#### Standing Instruction: Standing Instruction with or without Token. Transaction amount in case First payment is coming along with registration. Only 2 decimal places allowed  #### Create Mandate: You can create a mandate through the direct debit mandate flow. Possible create mandate status values:   - Pending—the create mandate request was successfully processed.   - Failed—the create mandate request was not accepted.  #### Import Mandate: In the Bacs scheme, a mandate is created with a status of active. Direct debit collections can be made against it immediately. You can import a mandate to the CyberSource database when:   - You have existing customers with signed, active mandates   - You manage mandates outside of CyberSource.  When you import an existing mandate to the CyberSource database, provide a unique value for the mandate ID or the request results in an error. If an import mandate request is not accepted, the import mandate status value is failed.
 
 ### Example
 ```php
@@ -135,7 +135,7 @@ Name | Type | Description  | Notes
 
 ### Return type
 
-[**\CyberSource\Model\PtsV2CreditsPost201Response1**](../Model/PtsV2CreditsPost201Response1.md)
+[**\CyberSource\Model\PtsV2CreateBillingAgreementPost201Response**](../Model/PtsV2CreateBillingAgreementPost201Response.md)
 
 ### Authorization
 

docs/Api/PaymentsApi.md

@@ -4,11 +4,61 @@ All URIs are relative to *https://apitest.cybersource.com*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------
+[**createOrderRequest**](PaymentsApi.md#createOrderRequest) | **POST** /pts/v2/payment-references/{id}/intents | Create a Payment Order Request
 [**createPayment**](PaymentsApi.md#createPayment) | **POST** /pts/v2/payments | Process a Payment
+[**createSessionRequest**](PaymentsApi.md#createSessionRequest) | **POST** /pts/v2/payment-references | Create Alternative Payments Sessions Request
 [**incrementAuth**](PaymentsApi.md#incrementAuth) | **PATCH** /pts/v2/payments/{id} | Increment an Authorization
 [**refreshPaymentStatus**](PaymentsApi.md#refreshPaymentStatus) | **POST** /pts/v2/refresh-payment-status/{id} | Check a Payment Status
+[**updateSessionReq**](PaymentsApi.md#updateSessionReq) | **PATCH** /pts/v2/payment-references/{id} | Update Alternative Payments Sessions Request
 
 
+# **createOrderRequest**
+> \CyberSource\Model\PtsV2PaymentsOrderPost201Response createOrderRequest($orderPaymentRequest, $id)
+
+Create a Payment Order Request
+
+Create a Payment Order Request
+
+### Example
+```php
+<?php
+require_once(__DIR__ . '/vendor/autoload.php');
+
+$api_instance = new CyberSource\Api\PaymentsApi();
+$orderPaymentRequest = new \CyberSource\Model\OrderPaymentRequest(); // \CyberSource\Model\OrderPaymentRequest | 
+$id = "id_example"; // string | Request identifier number for the order request.
+
+try {
+    $result = $api_instance->createOrderRequest($orderPaymentRequest, $id);
+    print_r($result);
+} catch (Exception $e) {
+    echo 'Exception when calling PaymentsApi->createOrderRequest: ', $e->getMessage(), PHP_EOL;
+}
+?>
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **orderPaymentRequest** | [**\CyberSource\Model\OrderPaymentRequest**](../Model/OrderPaymentRequest.md)|  |
+ **id** | **string**| Request identifier number for the order request. |
+
+### Return type
+
+[**\CyberSource\Model\PtsV2PaymentsOrderPost201Response**](../Model/PtsV2PaymentsOrderPost201Response.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json;charset=utf-8
+ - **Accept**: application/hal+json;charset=utf-8
+
+[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
+
 # **createPayment**
 > \CyberSource\Model\PtsV2PaymentsPost201Response createPayment($createPaymentRequest)
 
@@ -54,6 +104,51 @@ No authorization required
 
 [[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
 
+# **createSessionRequest**
+> \CyberSource\Model\PtsV2PaymentsPost201Response2 createSessionRequest($createSessionReq)
+
+Create Alternative Payments Sessions Request
+
+Create Alternative Payments Sessions Request
+
+### Example
+```php
+<?php
+require_once(__DIR__ . '/vendor/autoload.php');
+
+$api_instance = new CyberSource\Api\PaymentsApi();
+$createSessionReq = new \CyberSource\Model\CreateSessionReq(); // \CyberSource\Model\CreateSessionReq | 
+
+try {
+    $result = $api_instance->createSessionRequest($createSessionReq);
+    print_r($result);
+} catch (Exception $e) {
+    echo 'Exception when calling PaymentsApi->createSessionRequest: ', $e->getMessage(), PHP_EOL;
+}
+?>
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **createSessionReq** | [**\CyberSource\Model\CreateSessionReq**](../Model/CreateSessionReq.md)|  |
+
+### Return type
+
+[**\CyberSource\Model\PtsV2PaymentsPost201Response2**](../Model/PtsV2PaymentsPost201Response2.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json;charset=utf-8
+ - **Accept**: application/hal+json;charset=utf-8
+
+[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
+
 # **incrementAuth**
 > \CyberSource\Model\PtsV2IncrementalAuthorizationPatch201Response incrementAuth($id, $incrementAuthRequest)
 
@@ -148,3 +243,50 @@ No authorization required
 
 [[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
 
+# **updateSessionReq**
+> \CyberSource\Model\PtsV2PaymentsPost201Response2 updateSessionReq($createSessionRequest, $id)
+
+Update Alternative Payments Sessions Request
+
+Update Alternative Payments Sessions Request
+
+### Example
+```php
+<?php
+require_once(__DIR__ . '/vendor/autoload.php');
+
+$api_instance = new CyberSource\Api\PaymentsApi();
+$createSessionRequest = new \CyberSource\Model\CreateSessionRequest(); // \CyberSource\Model\CreateSessionRequest | 
+$id = "id_example"; // string | The payment ID. This ID is returned from a previous payment request.
+
+try {
+    $result = $api_instance->updateSessionReq($createSessionRequest, $id);
+    print_r($result);
+} catch (Exception $e) {
+    echo 'Exception when calling PaymentsApi->updateSessionReq: ', $e->getMessage(), PHP_EOL;
+}
+?>
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **createSessionRequest** | [**\CyberSource\Model\CreateSessionRequest**](../Model/CreateSessionRequest.md)|  |
+ **id** | **string**| The payment ID. This ID is returned from a previous payment request. |
+
+### Return type
+
+[**\CyberSource\Model\PtsV2PaymentsPost201Response2**](../Model/PtsV2PaymentsPost201Response2.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json;charset=utf-8
+ - **Accept**: application/hal+json;charset=utf-8
+
+[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
+

docs/Api/TransientTokenDataApi.md

@@ -4,9 +4,55 @@ All URIs are relative to *https://apitest.cybersource.com*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------
+[**getPaymentCredentialsForTransientToken**](TransientTokenDataApi.md#getPaymentCredentialsForTransientToken) | **GET** /up/v1/payment-credentials/{jti} | Get Payment Credentials
 [**getTransactionForTransientToken**](TransientTokenDataApi.md#getTransactionForTransientToken) | **GET** /up/v1/payment-details/{transientToken} | Get Transient Token Data
 
 
+# **getPaymentCredentialsForTransientToken**
+> string getPaymentCredentialsForTransientToken($jti)
+
+Get Payment Credentials
+
+Retrieve the Payment data captured by Unified Checkout. This API is used to retrieve the detailed data represented by the Transient Token. This API will return PCI payment data captured by the Unified Checkout platform.
+
+### Example
+```php
+<?php
+require_once(__DIR__ . '/vendor/autoload.php');
+
+$api_instance = new CyberSource\Api\TransientTokenDataApi();
+$jti = "jti_example"; // string | The jti field contained within the Transient token returned from a successful Unified Checkout transaction
+
+try {
+    $result = $api_instance->getPaymentCredentialsForTransientToken($jti);
+    print_r($result);
+} catch (Exception $e) {
+    echo 'Exception when calling TransientTokenDataApi->getPaymentCredentialsForTransientToken: ', $e->getMessage(), PHP_EOL;
+}
+?>
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **jti** | **string**| The jti field contained within the Transient token returned from a successful Unified Checkout transaction |
+
+### Return type
+
+**string**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json;charset=utf-8
+ - **Accept**: application/json
+
+[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
+
 # **getTransactionForTransientToken**
 > getTransactionForTransientToken($transientToken)
 

docs/Api/UnifiedCheckoutCaptureContextApi.md

@@ -12,7 +12,7 @@ Method | HTTP request | Description
 
 Generate Unified Checkout Capture Context
 
-Generate a one-time use capture context used for the invocation of Unified Checkout. The Request wil contain all of the parameters for how Unified Checkout will operate within a client webpage. The resulting payload will be a JWT signed object that can be used to initiate Unified Checkout within a merchant web page
+Unified Checkout is a powerful product within the Digital Acceptance Suite. Unified Checkout is designed to assist merchants with the adoption and inclusion of digital payments within their payment acceptance page. With Unified Checkout Integration you can add digital payment methods to create familiar, convenient and seamless payment experiences that are designed to reduce checkout friction and increase conversions. Click to Pay Drop-in UI is built on the Unified Checkout platform. For more information about Unified Checkout, see the [Unified Checkout Developer Guides Page](https://developer.cybersource.com/docs/cybs/en-us/unified-checkout/developer/all/rest/unified-checkout/uc-intro.html). For examples on how to integrate Unified Checkout within your webpage please see our [GitHub Unified Checkout Samples](https://github.com/CyberSource/cybersource-unified-checkout-sample-java). For more information about Click to Pay drop in UI, see the [Click to Pay Drop-in UI Developer Guides Page](https://developer.cybersource.com/docs/cybs/en-us/click-to-pay/developer/all/rest/click-to-pay/ctp-intro.html). Generate Unified Checkout Capture Context Generate a one-time use capture context used for the invocation of Unified Checkout. The Request wil contain all of the parameters for how Unified Checkout will operate within a client webpage. The resulting payload will be a JWT signed object that can be used to initiate Unified Checkout or Click to Pay Drop-in UI within a web page
 
 ### Example
 ```php

docs/Model/AuthReversalRequest.md

@@ -8,6 +8,8 @@ Name | Type | Description | Notes
 **processingInformation** | [**\CyberSource\Model\Ptsv2paymentsidreversalsProcessingInformation**](Ptsv2paymentsidreversalsProcessingInformation.md) |  | [optional] 
 **orderInformation** | [**\CyberSource\Model\Ptsv2paymentsidreversalsOrderInformation**](Ptsv2paymentsidreversalsOrderInformation.md) |  | [optional] 
 **pointOfSaleInformation** | [**\CyberSource\Model\Ptsv2paymentsidreversalsPointOfSaleInformation**](Ptsv2paymentsidreversalsPointOfSaleInformation.md) |  | [optional] 
+**paymentInformation** | [**\CyberSource\Model\Ptsv2paymentsidreversalsPaymentInformation**](Ptsv2paymentsidreversalsPaymentInformation.md) |  | [optional] 
+**processorInformation** | [**\CyberSource\Model\Ptsv2paymentsProcessorInformationReversal**](Ptsv2paymentsProcessorInformationReversal.md) |  | [optional] 
 
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
 

docs/Model/CardProcessingConfigCommon.md

@@ -3,7 +3,7 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**processors** | [**map[string,\CyberSource\Model\CardProcessingConfigCommonProcessors]**](CardProcessingConfigCommonProcessors.md) | e.g. * amexdirect * barclays2 * CUP * EFTPOS * fdiglobal * gpx * smartfdc * tsys * vero * VPC  For VPC, CUP and EFTPOS processors, replace the processor name from VPC or CUP or EFTPOS to the actual processor name in the sample request. e.g. replace VPC with <your vpc processor> | [optional] 
+**processors** | [**map[string,\CyberSource\Model\CardProcessingConfigCommonProcessors]**](CardProcessingConfigCommonProcessors.md) | e.g. * amexdirect * barclays2 * CUP * EFTPOS * fdiglobal * gpngsapv3 * gpx * smartfdc * tsys * vero * VPC  For VPC, CUP and EFTPOS processors, replace the processor name from VPC or CUP or EFTPOS to the actual processor name in the sample request. e.g. replace VPC with <your vpc processor> | [optional] 
 **amexVendorCode** | **string** | Vendor code assigned by American Express. Applicable for TSYS (tsys) processor. | [optional] 
 **defaultAuthTypeCode** | **string** | Authorization Finality indicator. Please note that the input can be in small case or capitals but response is in small case as of now. It will be made capitals everywhere in the next version. Applicable for Elavon Americas (elavonamericas), TSYS (tsys), Barclays (barclays2), Streamline (streamline2), Six (six), Barclays HISO (barclayshiso), GPN (gpn), FDI Global (fdiglobal), GPX (gpx), Paymentech Tampa (paymentechtampa), FDC Nashville (smartfdc), VPC and Chase Paymentech Salem (chasepaymentechsalem) processors.  Validation details (for selected processors)...  <table> <thead><tr><th>Processor</th><th>Acceptance Type</th><th>Required</th><th>Default Value</th></tr></thead> <tr><td>Barclays</td><td>cnp, cp, hybrid</td><td>No</td><td>FINAL</td></tr> <tr><td>Barclays HISO</td><td>cnp, cp, hybrid</td><td>Yes</td><td>FINAL</td></tr> </table> | [optional] 
 **masterCardAssignedId** | **string** | MAID aka MasterCard assigned ID, MasterCard equivalent of Merchant Verification Value by Visa. Applicable for VPC, GPX (gpx) and FDI Global (fdiglobal) processors. | [optional]