Merge pull request #174 from CyberSource/release-jan25

spec changes
CyberSource · Feb 5, 2025 · 417cf8e · 417cf8e
2 parents 29dae1a + 36612ff
commit 417cf8e
Show file tree

Hide file tree

Showing 276 changed files with 15,822 additions and 6,759 deletions.
diff --git a/README.md b/README.md
@@ -29,7 +29,7 @@ override the new secure-http default setting)*.
 {
   "require": {
     "php": ">=8.0.0", 
-    "cybersource/rest-client-php": "0.0.57"
+    "cybersource/rest-client-php": "0.0.58"
   }
 }
 ```

diff --git a/composer.json b/composer.json
@@ -1,6 +1,6 @@
 {
     "name": "cybersource/rest-client-php",
-    "version": "0.0.57",
+    "version": "0.0.58",
     "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"

diff --git a/docs/Api/InstrumentIdentifierApi.md b/docs/Api/InstrumentIdentifierApi.md
@@ -59,7 +59,7 @@ 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)
 
 # **getInstrumentIdentifier**
-> \CyberSource\Model\PostInstrumentIdentifierRequest getInstrumentIdentifier($instrumentIdentifierId, $profileId)
+> \CyberSource\Model\PostInstrumentIdentifierRequest getInstrumentIdentifier($instrumentIdentifierId, $profileId, $retrieveBinDetails)
 
 Retrieve an Instrument Identifier
 
@@ -73,9 +73,10 @@ require_once(__DIR__ . '/vendor/autoload.php');
 $api_instance = new CyberSource\Api\InstrumentIdentifierApi();
 $instrumentIdentifierId = "instrumentIdentifierId_example"; // string | The Id of an Instrument Identifier.
 $profileId = "profileId_example"; // string | The Id of a profile containing user specific TMS configuration.
+$retrieveBinDetails = true; // bool | Retrieve the Bin Details of PAN or network token
 
 try {
-    $result = $api_instance->getInstrumentIdentifier($instrumentIdentifierId, $profileId);
+    $result = $api_instance->getInstrumentIdentifier($instrumentIdentifierId, $profileId, $retrieveBinDetails);
     print_r($result);
 } catch (Exception $e) {
     echo 'Exception when calling InstrumentIdentifierApi->getInstrumentIdentifier: ', $e->getMessage(), PHP_EOL;
@@ -89,6 +90,7 @@ Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **instrumentIdentifierId** | **string**| The Id of an Instrument Identifier. |
  **profileId** | **string**| The Id of a profile containing user specific TMS configuration. | [optional]
+ **retrieveBinDetails** | **bool**| Retrieve the Bin Details of PAN or network token | [optional]
 
 ### Return type
 
@@ -106,7 +108,7 @@ 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)
 
 # **getInstrumentIdentifierPaymentInstrumentsList**
-> \CyberSource\Model\PaymentInstrumentList1 getInstrumentIdentifierPaymentInstrumentsList($instrumentIdentifierId, $profileId, $offset, $limit)
+> \CyberSource\Model\PaymentInstrumentList1 getInstrumentIdentifierPaymentInstrumentsList($instrumentIdentifierId, $profileId, $retrieveBinDetails, $offset, $limit)
 
 List Payment Instruments for an Instrument Identifier
 
@@ -120,11 +122,12 @@ require_once(__DIR__ . '/vendor/autoload.php');
 $api_instance = new CyberSource\Api\InstrumentIdentifierApi();
 $instrumentIdentifierId = "instrumentIdentifierId_example"; // string | The Id of an Instrument Identifier.
 $profileId = "profileId_example"; // string | The Id of a profile containing user specific TMS configuration.
+$retrieveBinDetails = true; // bool | Retrieve the Bin Details of PAN or network token
 $offset = 0; // int | Starting record in zero-based dataset that should be returned as the first object in the array. Default is 0.
 $limit = 20; // int | The maximum number that can be returned in the array starting from the offset record in zero-based dataset. Default is 20, maximum is 100.
 
 try {
-    $result = $api_instance->getInstrumentIdentifierPaymentInstrumentsList($instrumentIdentifierId, $profileId, $offset, $limit);
+    $result = $api_instance->getInstrumentIdentifierPaymentInstrumentsList($instrumentIdentifierId, $profileId, $retrieveBinDetails, $offset, $limit);
     print_r($result);
 } catch (Exception $e) {
     echo 'Exception when calling InstrumentIdentifierApi->getInstrumentIdentifierPaymentInstrumentsList: ', $e->getMessage(), PHP_EOL;
@@ -138,6 +141,7 @@ Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **instrumentIdentifierId** | **string**| The Id of an Instrument Identifier. |
  **profileId** | **string**| The Id of a profile containing user specific TMS configuration. | [optional]
+ **retrieveBinDetails** | **bool**| Retrieve the Bin Details of PAN or network token | [optional]
  **offset** | **int**| Starting record in zero-based dataset that should be returned as the first object in the array. Default is 0. | [optional] [default to 0]
  **limit** | **int**| The maximum number that can be returned in the array starting from the offset record in zero-based dataset. Default is 20, maximum is 100. | [optional] [default to 20]
 
@@ -157,7 +161,7 @@ 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)
 
 # **patchInstrumentIdentifier**
-> \CyberSource\Model\PatchInstrumentIdentifierRequest patchInstrumentIdentifier($instrumentIdentifierId, $patchInstrumentIdentifierRequest, $profileId, $ifMatch)
+> \CyberSource\Model\PatchInstrumentIdentifierRequest patchInstrumentIdentifier($instrumentIdentifierId, $patchInstrumentIdentifierRequest, $profileId, $retrieveBinDetails, $ifMatch)
 
 Update an Instrument Identifier
 
@@ -172,10 +176,11 @@ $api_instance = new CyberSource\Api\InstrumentIdentifierApi();
 $instrumentIdentifierId = "instrumentIdentifierId_example"; // string | The Id of an Instrument Identifier.
 $patchInstrumentIdentifierRequest = new \CyberSource\Model\PatchInstrumentIdentifierRequest(); // \CyberSource\Model\PatchInstrumentIdentifierRequest | Specify the previous transaction Id to update.
 $profileId = "profileId_example"; // string | The Id of a profile containing user specific TMS configuration.
+$retrieveBinDetails = true; // bool | Retrieve the Bin Details of PAN or network token
 $ifMatch = "ifMatch_example"; // string | Contains an ETag value from a GET request to make the request conditional.
 
 try {
-    $result = $api_instance->patchInstrumentIdentifier($instrumentIdentifierId, $patchInstrumentIdentifierRequest, $profileId, $ifMatch);
+    $result = $api_instance->patchInstrumentIdentifier($instrumentIdentifierId, $patchInstrumentIdentifierRequest, $profileId, $retrieveBinDetails, $ifMatch);
     print_r($result);
 } catch (Exception $e) {
     echo 'Exception when calling InstrumentIdentifierApi->patchInstrumentIdentifier: ', $e->getMessage(), PHP_EOL;
@@ -190,6 +195,7 @@ Name | Type | Description  | Notes
  **instrumentIdentifierId** | **string**| The Id of an Instrument Identifier. |
  **patchInstrumentIdentifierRequest** | [**\CyberSource\Model\PatchInstrumentIdentifierRequest**](../Model/PatchInstrumentIdentifierRequest.md)| Specify the previous transaction Id to update. |
  **profileId** | **string**| The Id of a profile containing user specific TMS configuration. | [optional]
+ **retrieveBinDetails** | **bool**| Retrieve the Bin Details of PAN or network token | [optional]
  **ifMatch** | **string**| Contains an ETag value from a GET request to make the request conditional. | [optional]
 
 ### Return type
@@ -208,7 +214,7 @@ 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)
 
 # **postInstrumentIdentifier**
-> \CyberSource\Model\PostInstrumentIdentifierRequest postInstrumentIdentifier($postInstrumentIdentifierRequest, $profileId)
+> \CyberSource\Model\PostInstrumentIdentifierRequest postInstrumentIdentifier($postInstrumentIdentifierRequest, $profileId, $retrieveBinDetails)
 
 Create an Instrument Identifier
 
@@ -222,9 +228,10 @@ require_once(__DIR__ . '/vendor/autoload.php');
 $api_instance = new CyberSource\Api\InstrumentIdentifierApi();
 $postInstrumentIdentifierRequest = new \CyberSource\Model\PostInstrumentIdentifierRequest(); // \CyberSource\Model\PostInstrumentIdentifierRequest | Specify either a Card, Bank Account or Enrollable Card
 $profileId = "profileId_example"; // string | The Id of a profile containing user specific TMS configuration.
+$retrieveBinDetails = true; // bool | Retrieve the Bin Details of PAN or network token
 
 try {
-    $result = $api_instance->postInstrumentIdentifier($postInstrumentIdentifierRequest, $profileId);
+    $result = $api_instance->postInstrumentIdentifier($postInstrumentIdentifierRequest, $profileId, $retrieveBinDetails);
     print_r($result);
 } catch (Exception $e) {
     echo 'Exception when calling InstrumentIdentifierApi->postInstrumentIdentifier: ', $e->getMessage(), PHP_EOL;
@@ -238,6 +245,7 @@ Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **postInstrumentIdentifierRequest** | [**\CyberSource\Model\PostInstrumentIdentifierRequest**](../Model/PostInstrumentIdentifierRequest.md)| Specify either a Card, Bank Account or Enrollable Card |
  **profileId** | **string**| The Id of a profile containing user specific TMS configuration. | [optional]
+ **retrieveBinDetails** | **bool**| Retrieve the Bin Details of PAN or network token | [optional]
 
 ### Return type
 

diff --git a/docs/Api/PaymentInstrumentApi.md b/docs/Api/PaymentInstrumentApi.md
@@ -57,7 +57,7 @@ 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)
 
 # **getPaymentInstrument**
-> \CyberSource\Model\PostPaymentInstrumentRequest getPaymentInstrument($paymentInstrumentId, $profileId)
+> \CyberSource\Model\PostPaymentInstrumentRequest getPaymentInstrument($paymentInstrumentId, $profileId, $retrieveBinDetails)
 
 Retrieve a Payment Instrument
 
@@ -71,9 +71,10 @@ require_once(__DIR__ . '/vendor/autoload.php');
 $api_instance = new CyberSource\Api\PaymentInstrumentApi();
 $paymentInstrumentId = "paymentInstrumentId_example"; // string | The Id of a payment instrument.
 $profileId = "profileId_example"; // string | The Id of a profile containing user specific TMS configuration.
+$retrieveBinDetails = true; // bool | Retrieve the Bin Details of PAN or network token
 
 try {
-    $result = $api_instance->getPaymentInstrument($paymentInstrumentId, $profileId);
+    $result = $api_instance->getPaymentInstrument($paymentInstrumentId, $profileId, $retrieveBinDetails);
     print_r($result);
 } catch (Exception $e) {
     echo 'Exception when calling PaymentInstrumentApi->getPaymentInstrument: ', $e->getMessage(), PHP_EOL;
@@ -87,6 +88,7 @@ Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **paymentInstrumentId** | **string**| The Id of a payment instrument. |
  **profileId** | **string**| The Id of a profile containing user specific TMS configuration. | [optional]
+ **retrieveBinDetails** | **bool**| Retrieve the Bin Details of PAN or network token | [optional]
 
 ### Return type
 
@@ -104,7 +106,7 @@ 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)
 
 # **patchPaymentInstrument**
-> \CyberSource\Model\PatchPaymentInstrumentRequest patchPaymentInstrument($paymentInstrumentId, $patchPaymentInstrumentRequest, $profileId, $ifMatch)
+> \CyberSource\Model\PatchPaymentInstrumentRequest patchPaymentInstrument($paymentInstrumentId, $patchPaymentInstrumentRequest, $profileId, $retrieveBinDetails, $ifMatch)
 
 Update a Payment Instrument
 
@@ -119,10 +121,11 @@ $api_instance = new CyberSource\Api\PaymentInstrumentApi();
 $paymentInstrumentId = "paymentInstrumentId_example"; // string | The Id of a payment instrument.
 $patchPaymentInstrumentRequest = new \CyberSource\Model\PatchPaymentInstrumentRequest(); // \CyberSource\Model\PatchPaymentInstrumentRequest | 
 $profileId = "profileId_example"; // string | The Id of a profile containing user specific TMS configuration.
+$retrieveBinDetails = true; // bool | Retrieve the Bin Details of PAN or network token
 $ifMatch = "ifMatch_example"; // string | Contains an ETag value from a GET request to make the request conditional.
 
 try {
-    $result = $api_instance->patchPaymentInstrument($paymentInstrumentId, $patchPaymentInstrumentRequest, $profileId, $ifMatch);
+    $result = $api_instance->patchPaymentInstrument($paymentInstrumentId, $patchPaymentInstrumentRequest, $profileId, $retrieveBinDetails, $ifMatch);
     print_r($result);
 } catch (Exception $e) {
     echo 'Exception when calling PaymentInstrumentApi->patchPaymentInstrument: ', $e->getMessage(), PHP_EOL;
@@ -137,6 +140,7 @@ Name | Type | Description  | Notes
  **paymentInstrumentId** | **string**| The Id of a payment instrument. |
  **patchPaymentInstrumentRequest** | [**\CyberSource\Model\PatchPaymentInstrumentRequest**](../Model/PatchPaymentInstrumentRequest.md)|  |
  **profileId** | **string**| The Id of a profile containing user specific TMS configuration. | [optional]
+ **retrieveBinDetails** | **bool**| Retrieve the Bin Details of PAN or network token | [optional]
  **ifMatch** | **string**| Contains an ETag value from a GET request to make the request conditional. | [optional]
 
 ### Return type
@@ -155,7 +159,7 @@ 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)
 
 # **postPaymentInstrument**
-> \CyberSource\Model\PostPaymentInstrumentRequest postPaymentInstrument($postPaymentInstrumentRequest, $profileId)
+> \CyberSource\Model\PostPaymentInstrumentRequest postPaymentInstrument($postPaymentInstrumentRequest, $profileId, $retrieveBinDetails)
 
 Create a Payment Instrument
 
@@ -169,9 +173,10 @@ require_once(__DIR__ . '/vendor/autoload.php');
 $api_instance = new CyberSource\Api\PaymentInstrumentApi();
 $postPaymentInstrumentRequest = new \CyberSource\Model\PostPaymentInstrumentRequest(); // \CyberSource\Model\PostPaymentInstrumentRequest | 
 $profileId = "profileId_example"; // string | The Id of a profile containing user specific TMS configuration.
+$retrieveBinDetails = true; // bool | Retrieve the Bin Details of PAN or network token
 
 try {
-    $result = $api_instance->postPaymentInstrument($postPaymentInstrumentRequest, $profileId);
+    $result = $api_instance->postPaymentInstrument($postPaymentInstrumentRequest, $profileId, $retrieveBinDetails);
     print_r($result);
 } catch (Exception $e) {
     echo 'Exception when calling PaymentInstrumentApi->postPaymentInstrument: ', $e->getMessage(), PHP_EOL;
@@ -185,6 +190,7 @@ Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **postPaymentInstrumentRequest** | [**\CyberSource\Model\PostPaymentInstrumentRequest**](../Model/PostPaymentInstrumentRequest.md)|  |
  **profileId** | **string**| The Id of a profile containing user specific TMS configuration. | [optional]
+ **retrieveBinDetails** | **bool**| Retrieve the Bin Details of PAN or network token | [optional]
 
 ### Return type
 

diff --git a/docs/Model/CreatePaymentRequest.md b/docs/Model/CreatePaymentRequest.md
@@ -29,6 +29,7 @@ Name | Type | Description | Notes
 **riskInformation** | [**\CyberSource\Model\Ptsv2paymentsRiskInformation**](Ptsv2paymentsRiskInformation.md) |  | [optional] 
 **acquirerInformation** | [**\CyberSource\Model\Ptsv2paymentsAcquirerInformation**](Ptsv2paymentsAcquirerInformation.md) |  | [optional] 
 **recurringPaymentInformation** | [**\CyberSource\Model\Ptsv2paymentsRecurringPaymentInformation**](Ptsv2paymentsRecurringPaymentInformation.md) |  | [optional] 
+**unscheduledPaymentInformation** | [**\CyberSource\Model\Ptsv2paymentsUnscheduledPaymentInformation**](Ptsv2paymentsUnscheduledPaymentInformation.md) |  | [optional] 
 **hostedPaymentInformation** | [**\CyberSource\Model\Ptsv2paymentsHostedPaymentInformation**](Ptsv2paymentsHostedPaymentInformation.md) |  | [optional] 
 **watchlistScreeningInformation** | [**\CyberSource\Model\Ptsv2paymentsWatchlistScreeningInformation**](Ptsv2paymentsWatchlistScreeningInformation.md) |  | [optional] 
 

diff --git a/docs/Model/GenerateCaptureContextRequest.md b/docs/Model/GenerateCaptureContextRequest.md
@@ -5,8 +5,8 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **clientVersion** | **string** | Specify the version of Microform that you want to use. | [optional] 
 **targetOrigins** | **string[]** | The [target origin](https://developer.mozilla.org/en-US/docs/Glossary/Origin) of the website on which you will be launching Microform is defined by the scheme (protocol), hostname (domain) and port number (if used).    You must use https://hostname (unless you use http://localhost) Wildcards are NOT supported.  Ensure that subdomains are included. Any valid top-level domain is supported (e.g. .com, .co.uk, .gov.br etc)  Examples:   - https://example.com   - https://subdomain.example.com   - https://example.com:8080&lt;br&gt;&lt;br&gt;  If you are embedding within multiple nested iframes you need to specify the origins of all the browser contexts used, for example:    targetOrigins: [     \&quot;https://example.com\&quot;,     \&quot;https://basket.example.com\&quot;,     \&quot;https://ecom.example.com\&quot;   ] | [optional] 
-**allowedCardNetworks** | **string[]** | The list of card networks you want to use for this Microform transaction.  Microform currently supports the following card networks: - VISA - MASTERCARD - AMEX - CARNET - CARTESBANCAIRES - CUP - DINERSCLUB - DISCOVER - EFTPOS - ELO - JCB - JCREW - MADA - MAESTRO - MEEZA | [optional] 
-**checkoutApiInitialization** | [**\CyberSource\Model\Microformv2sessionsCheckoutApiInitialization**](Microformv2sessionsCheckoutApiInitialization.md) |  | [optional] 
+**allowedCardNetworks** | **string[]** | The list of card networks you want to use for this Microform transaction.  Microform currently supports the following card networks: - VISA - MASTERCARD - AMEX - CARNET - CARTESBANCAIRES - CUP - DINERSCLUB - DISCOVER - EFTPOS - ELO - JCB - JCREW - MADA - MAESTRO - MEEZA  **Important:**    - When integrating Microform (Accept Card) at least one card network should be specified in the allowedCardNetworks field in the capture context request.   - When integrating Microform (Accept Check) the allowedCardNetworks field is not required in the capture context request.   - When integrating both Microform (Accept Card) and Microform (Accept Check) at least one card network should be specified in the allowedCardNetworks field in the capture context request. | [optional] 
+**allowedPaymentTypes** | **string[]** | The payment types that are allowed for the merchant.    Possible values when launching Microform: - CARD - CHECK &lt;br&gt;&lt;br&gt; | [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)