cybersource-rest-client 0.0.66 → 0.0.68

package/docs/PaymentLinksApi.md

@@ -0,0 +1,206 @@
+# CyberSource.PaymentLinksApi
+
+All URIs are relative to *https://apitest.cybersource.com*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**createPaymentLink**](PaymentLinksApi.md#createPaymentLink) | **POST** /ipl/v2/payment-links | Create a Payment Link
+[**getAllPaymentLinks**](PaymentLinksApi.md#getAllPaymentLinks) | **GET** /ipl/v2/payment-links | Get a List of Payment Links
+[**getPaymentLink**](PaymentLinksApi.md#getPaymentLink) | **GET** /ipl/v2/payment-links/{id} | Get Payment Link Details
+[**updatePaymentLink**](PaymentLinksApi.md#updatePaymentLink) | **PATCH** /ipl/v2/payment-links/{id} | Update a Payment Link
+
+
+<a name="createPaymentLink"></a>
+# **createPaymentLink**
+> PblPaymentLinksPost201Response createPaymentLink(createPaymentLinkRequest)
+
+Create a Payment Link
+
+Create a new payment link.
+
+### Example
+```javascript
+var CyberSource = require('CyberSource');
+
+var apiInstance = new CyberSource.PaymentLinksApi();
+
+var createPaymentLinkRequest = new CyberSource.CreatePaymentLinkRequest(); // CreatePaymentLinkRequest | 
+
+
+var callback = function(error, data, response) {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+};
+apiInstance.createPaymentLink(createPaymentLinkRequest, callback);
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **createPaymentLinkRequest** | [**CreatePaymentLinkRequest**](CreatePaymentLinkRequest.md)|  | 
+
+### Return type
+
+[**PblPaymentLinksPost201Response**](PblPaymentLinksPost201Response.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json;charset=utf-8
+ - **Accept**: application/json, application/hal+json, application/json;charset=utf-8, application/hal+json;charset=utf-8
+
+<a name="getAllPaymentLinks"></a>
+# **getAllPaymentLinks**
+> PblPaymentLinksAllGet200Response getAllPaymentLinks(offset, limit, opts)
+
+Get a List of Payment Links
+
+Provides a (filtered) list of payment links that have been created in your account. You can filter the list based on the following status types:  - ACTIVE  - INACTIVE 
+
+### Example
+```javascript
+var CyberSource = require('CyberSource');
+
+var apiInstance = new CyberSource.PaymentLinksApi();
+
+var offset = 56; // Number | Page offset number.
+
+var limit = 56; // Number | Maximum number of items you would like returned.   Maximum limit: 1000 
+
+var opts = { 
+  'status': "status_example" // String | The status of the purchase or donation link.  Possible values:   - ACTIVE   - INACTIVE 
+};
+
+var callback = function(error, data, response) {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+};
+apiInstance.getAllPaymentLinks(offset, limit, opts, callback);
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **offset** | **Number**| Page offset number. | 
+ **limit** | **Number**| Maximum number of items you would like returned.   Maximum limit: 1000  | 
+ **status** | **String**| The status of the purchase or donation link.  Possible values:   - ACTIVE   - INACTIVE  | [optional] 
+
+### Return type
+
+[**PblPaymentLinksAllGet200Response**](PblPaymentLinksAllGet200Response.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json;charset=utf-8
+ - **Accept**: application/json, application/hal+json, application/json;charset=utf-8, application/hal+json;charset=utf-8
+
+<a name="getPaymentLink"></a>
+# **getPaymentLink**
+> PblPaymentLinksGet200Response getPaymentLink(id)
+
+Get Payment Link Details
+
+You can retrieve details of a specific payment link. For each payment transaction you can use the Transaction Details API to get more details on the payment transaction.
+
+### Example
+```javascript
+var CyberSource = require('CyberSource');
+
+var apiInstance = new CyberSource.PaymentLinksApi();
+
+var id = "id_example"; // String | The purchase number.
+
+
+var callback = function(error, data, response) {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+};
+apiInstance.getPaymentLink(id, callback);
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **String**| The purchase number. | 
+
+### Return type
+
+[**PblPaymentLinksGet200Response**](PblPaymentLinksGet200Response.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json;charset=utf-8
+ - **Accept**: application/json, application/hal+json, application/json;charset=utf-8, application/hal+json;charset=utf-8
+
+<a name="updatePaymentLink"></a>
+# **updatePaymentLink**
+> PblPaymentLinksPost201Response updatePaymentLink(id, updatePaymentLinkRequest)
+
+Update a Payment Link
+
+You can update all information except the payment link number until any payment is received for a payment link.
+
+### Example
+```javascript
+var CyberSource = require('CyberSource');
+
+var apiInstance = new CyberSource.PaymentLinksApi();
+
+var id = "id_example"; // String | The purchase number.
+
+var updatePaymentLinkRequest = new CyberSource.UpdatePaymentLinkRequest(); // UpdatePaymentLinkRequest | Updating the purchase or donation link does not resend the link automatically. You must resend the purchase or donation link separately.
+
+
+var callback = function(error, data, response) {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+};
+apiInstance.updatePaymentLink(id, updatePaymentLinkRequest, callback);
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **String**| The purchase number. | 
+ **updatePaymentLinkRequest** | [**UpdatePaymentLinkRequest**](UpdatePaymentLinkRequest.md)| Updating the purchase or donation link does not resend the link automatically. You must resend the purchase or donation link separately. | 
+
+### Return type
+
+[**PblPaymentLinksPost201Response**](PblPaymentLinksPost201Response.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json;charset=utf-8
+ - **Accept**: application/json, application/hal+json, application/json;charset=utf-8, application/hal+json;charset=utf-8
+

package/docs/PaymentsProducts.md

@@ -4,6 +4,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **cardProcessing** | [**PaymentsProductsCardProcessing**](PaymentsProductsCardProcessing.md) |  | [optional] 
+**alternativePaymentMethods** | [**PaymentsProductsAlternativePaymentMethods**](PaymentsProductsAlternativePaymentMethods.md) |  | [optional] 
 **cardPresentConnect** | [**PaymentsProductsCardPresentConnect**](PaymentsProductsCardPresentConnect.md) |  | [optional] 
 **cybsReadyTerminal** | [**PaymentsProductsCybsReadyTerminal**](PaymentsProductsCybsReadyTerminal.md) |  | [optional] 
 **eCheck** | [**PaymentsProductsECheck**](PaymentsProductsECheck.md) |  | [optional] 

package/docs/PaymentsProductsAlternativePaymentMethods.md

@@ -0,0 +1,9 @@
+# CyberSource.PaymentsProductsAlternativePaymentMethods
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**subscriptionInformation** | [**PaymentsProductsAlternativePaymentMethodsSubscriptionInformation**](PaymentsProductsAlternativePaymentMethodsSubscriptionInformation.md) |  | [optional] 
+**configurationInformation** | [**PaymentsProductsAlternativePaymentMethodsConfigurationInformation**](PaymentsProductsAlternativePaymentMethodsConfigurationInformation.md) |  | [optional] 
+
+

package/docs/PaymentsProductsAlternativePaymentMethodsConfigurationInformation.md

@@ -0,0 +1,8 @@
+# CyberSource.PaymentsProductsAlternativePaymentMethodsConfigurationInformation
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**configurations** | [**PaymentsProductsAlternativePaymentMethodsConfigurationInformationConfigurations**](PaymentsProductsAlternativePaymentMethodsConfigurationInformationConfigurations.md) |  | [optional] 
+
+

package/docs/PaymentsProductsAlternativePaymentMethodsConfigurationInformationConfigurations.md

@@ -0,0 +1,9 @@
+# CyberSource.PaymentsProductsAlternativePaymentMethodsConfigurationInformationConfigurations
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**merchantCategoryCode** | **String** | Merchant Category Code (MCC) is a four-digit number assigned to a business by credit card companies when the business first starts accepting credit cards as a form of payment. The MCC is used to classify the business by the type of goods or services it provides.  | [optional] 
+**processors** | [**{String: PaymentsProductsAlternativePaymentMethodsConfigurationInformationConfigurationsProcessors}**](PaymentsProductsAlternativePaymentMethodsConfigurationInformationConfigurationsProcessors.md) | This is a map. The allowed keys are below. Value should be an object containing a sole boolean property - enabled. <table>   <tr>     <td>klarna</td>   </tr>   <tr>     <td>payPal</td>   </tr>   <tr>     <td>alipay</td>   </tr>   <tr>     <td>bancontact</td>   </tr>   <tr>     <td>giropay</td>   </tr>   <tr>     <td>ideal</td>   </tr> </table>  | [optional] 
+
+

package/docs/PaymentsProductsAlternativePaymentMethodsConfigurationInformationConfigurationsAdditionalConfigurations.md

@@ -0,0 +1,9 @@
+# CyberSource.PaymentsProductsAlternativePaymentMethodsConfigurationInformationConfigurationsAdditionalConfigurations
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**key** | **String** | Key for the additional configuration. This is used to identify the specific setting. example: serviceProviderId  | [optional] 
+**value** | **String** | Value for the additional configuration. This is the actual setting being configured. example: svcId  | [optional] 
+
+

package/docs/PaymentsProductsAlternativePaymentMethodsConfigurationInformationConfigurationsPaymentMethods.md

@@ -0,0 +1,13 @@
+# CyberSource.PaymentsProductsAlternativePaymentMethodsConfigurationInformationConfigurationsPaymentMethods
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**merchantId** | **String** | Merchant ID for the payment method. This is a unique identifier for the merchant. example. mid12345678  | [optional] 
+**logoUrl** | **String** | URL of the logo for the payment method. This is used for branding purposes. example: http://www.test.com  | [optional] 
+**redirectSuccessUrl** | **String** | URL to redirect to after a successful transaction. This is where the user will be sent after completing the payment. example: http://www.test.com/success  | [optional] 
+**redirectCancelUrl** | **String** | URL to redirect to if the user cancels the transaction. This is where the user will be sent if they choose to cancel the payment. example: http://www.test.com/cancel  | [optional] 
+**redirectFailureUrl** | **String** | URL to redirect to if the transaction fails. This is where the user will be sent if there is an error during the payment process. example: http://www.test.com/failure  | [optional] 
+**additionalConfigurations** | [**[PaymentsProductsAlternativePaymentMethodsConfigurationInformationConfigurationsAdditionalConfigurations]**](PaymentsProductsAlternativePaymentMethodsConfigurationInformationConfigurationsAdditionalConfigurations.md) | Additional configurations for the payment method. This can include various settings specific to the payment method.  | [optional] 
+
+

package/docs/PaymentsProductsAlternativePaymentMethodsConfigurationInformationConfigurationsProcessors.md

@@ -0,0 +1,8 @@
+# CyberSource.PaymentsProductsAlternativePaymentMethodsConfigurationInformationConfigurationsProcessors
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**paymentMethods** | [**{String: PaymentsProductsAlternativePaymentMethodsConfigurationInformationConfigurationsPaymentMethods}**](PaymentsProductsAlternativePaymentMethodsConfigurationInformationConfigurationsPaymentMethods.md) | Payment methods supported by the processor. The following values are supported: - klarna - CREDIT_CARD - DEBIT_CARD  | [optional] 
+
+

package/docs/{PaymentsProductsPayerAuthenticationSubscriptionInformation.md → PaymentsProductsAlternativePaymentMethodsSubscriptionInformation.md}

@@ -1,4 +1,4 @@
-# CyberSource.PaymentsProductsPayerAuthenticationSubscriptionInformation
+# CyberSource.PaymentsProductsAlternativePaymentMethodsSubscriptionInformation
 
 ## Properties
 Name | Type | Description | Notes

package/docs/PaymentsProductsCurrencyConversion.md

@@ -3,7 +3,7 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**subscriptionInformation** | [**PaymentsProductsPayerAuthenticationSubscriptionInformation**](PaymentsProductsPayerAuthenticationSubscriptionInformation.md) |  | [optional] 
+**subscriptionInformation** | [**PaymentsProductsAlternativePaymentMethodsSubscriptionInformation**](PaymentsProductsAlternativePaymentMethodsSubscriptionInformation.md) |  | [optional] 
 **configurationInformation** | [**PaymentsProductsCurrencyConversionConfigurationInformation**](PaymentsProductsCurrencyConversionConfigurationInformation.md) |  | [optional] 
 
 

package/docs/PaymentsProductsPayerAuthentication.md

@@ -3,7 +3,7 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**subscriptionInformation** | [**PaymentsProductsPayerAuthenticationSubscriptionInformation**](PaymentsProductsPayerAuthenticationSubscriptionInformation.md) |  | [optional] 
+**subscriptionInformation** | [**PaymentsProductsAlternativePaymentMethodsSubscriptionInformation**](PaymentsProductsAlternativePaymentMethodsSubscriptionInformation.md) |  | [optional] 
 **configurationInformation** | [**PaymentsProductsPayerAuthenticationConfigurationInformation**](PaymentsProductsPayerAuthenticationConfigurationInformation.md) |  | [optional] 
 
 

package/docs/PaymentsProductsPayouts.md

@@ -3,7 +3,7 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**subscriptionInformation** | [**PaymentsProductsPayerAuthenticationSubscriptionInformation**](PaymentsProductsPayerAuthenticationSubscriptionInformation.md) |  | [optional] 
+**subscriptionInformation** | [**PaymentsProductsAlternativePaymentMethodsSubscriptionInformation**](PaymentsProductsAlternativePaymentMethodsSubscriptionInformation.md) |  | [optional] 
 **configurationInformation** | [**PaymentsProductsPayoutsConfigurationInformation**](PaymentsProductsPayoutsConfigurationInformation.md) |  | [optional] 
 
 

package/docs/PaymentsProductsSecureAcceptance.md

@@ -3,7 +3,7 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**subscriptionInformation** | [**PaymentsProductsPayerAuthenticationSubscriptionInformation**](PaymentsProductsPayerAuthenticationSubscriptionInformation.md) |  | [optional] 
+**subscriptionInformation** | [**PaymentsProductsAlternativePaymentMethodsSubscriptionInformation**](PaymentsProductsAlternativePaymentMethodsSubscriptionInformation.md) |  | [optional] 
 **configurationInformation** | [**PaymentsProductsSecureAcceptanceConfigurationInformation**](PaymentsProductsSecureAcceptanceConfigurationInformation.md) |  | [optional] 
 
 

package/docs/PaymentsProductsServiceFee.md

@@ -3,7 +3,7 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**subscriptionInformation** | [**PaymentsProductsPayerAuthenticationSubscriptionInformation**](PaymentsProductsPayerAuthenticationSubscriptionInformation.md) |  | [optional] 
+**subscriptionInformation** | [**PaymentsProductsAlternativePaymentMethodsSubscriptionInformation**](PaymentsProductsAlternativePaymentMethodsSubscriptionInformation.md) |  | [optional] 
 **configurationInformation** | [**PaymentsProductsServiceFeeConfigurationInformation**](PaymentsProductsServiceFeeConfigurationInformation.md) |  | [optional] 
 
 

package/docs/PaymentsProductsTax.md

@@ -3,6 +3,6 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**subscriptionInformation** | [**PaymentsProductsPayerAuthenticationSubscriptionInformation**](PaymentsProductsPayerAuthenticationSubscriptionInformation.md) |  | [optional] 
+**subscriptionInformation** | [**PaymentsProductsAlternativePaymentMethodsSubscriptionInformation**](PaymentsProductsAlternativePaymentMethodsSubscriptionInformation.md) |  | [optional] 
 
 

package/docs/PaymentsProductsVirtualTerminal.md

@@ -3,7 +3,7 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**subscriptionInformation** | [**PaymentsProductsPayerAuthenticationSubscriptionInformation**](PaymentsProductsPayerAuthenticationSubscriptionInformation.md) |  | [optional] 
+**subscriptionInformation** | [**PaymentsProductsAlternativePaymentMethodsSubscriptionInformation**](PaymentsProductsAlternativePaymentMethodsSubscriptionInformation.md) |  | [optional] 
 **configurationInformation** | [**PaymentsProductsVirtualTerminalConfigurationInformation**](PaymentsProductsVirtualTerminalConfigurationInformation.md) |  | [optional] 
 
 

package/docs/PayoutsApi.md

@@ -13,7 +13,7 @@ Method | HTTP request | Description
 
 Process a Payout
 
-Send funds from a selected funding source to a designated credit/debit card account or a prepaid card using an Original Credit Transaction (OCT). 
+Send funds from a selected funding source to a designated credit/debit card account or a prepaid card using an Original Credit Transaction (OCT). The availability of API features for a merchant can depend on the portfolio configuration and may need to be enabled at the portfolio level before they can be added to merchant accounts. 
 
 ### Example
 ```javascript

package/docs/PblPaymentLinksAllGet200Response.md

@@ -0,0 +1,11 @@
+# CyberSource.PblPaymentLinksAllGet200Response
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**links** | [**GetAllPlansResponseLinks**](GetAllPlansResponseLinks.md) |  | [optional] 
+**submitTimeUtc** | **String** | Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ` **Example** `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the time. The `Z` indicates UTC.  Returned by Cybersource for all services.  | [optional] 
+**totalLinks** | **Number** |  | [optional] 
+**links** | [**[PblPaymentLinksAllGet200ResponseLinks]**](PblPaymentLinksAllGet200ResponseLinks.md) |  | [optional] 
+
+

package/docs/PblPaymentLinksAllGet200ResponseLinks.md

@@ -0,0 +1,14 @@
+# CyberSource.PblPaymentLinksAllGet200ResponseLinks
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**links** | [**GetAllPlansResponseLinks**](GetAllPlansResponseLinks.md) |  | [optional] 
+**id** | **String** | An unique identification number generated by Cybersource to identify the submitted request. Returned by all services. It is also appended to the endpoint of the resource. On incremental authorizations, this value with be the same as the identification number returned in the original authorization response.  | [optional] 
+**status** | **String** | The status of the purchase or donation link.  Possible values: - ACTIVE - INACTIVE  | [optional] 
+**createdDate** | **String** | Date and time (UTC) the invoice was created.  Format: YYYY-MM-DDThh:mm:ssZ Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the time. The Z indicates UTC.  | [optional] 
+**processingInformation** | [**PblPaymentLinksAllGet200ResponseProcessingInformation**](PblPaymentLinksAllGet200ResponseProcessingInformation.md) |  | [optional] 
+**purchaseInformation** | [**PblPaymentLinksAllGet200ResponsePurchaseInformation**](PblPaymentLinksAllGet200ResponsePurchaseInformation.md) |  | [optional] 
+**orderInformation** | [**PblPaymentLinksAllGet200ResponseOrderInformation**](PblPaymentLinksAllGet200ResponseOrderInformation.md) |  | [optional] 
+
+

package/docs/PblPaymentLinksAllGet200ResponseOrderInformation.md

@@ -0,0 +1,9 @@
+# CyberSource.PblPaymentLinksAllGet200ResponseOrderInformation
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**amountDetails** | [**PblPaymentLinksAllGet200ResponseOrderInformationAmountDetails**](PblPaymentLinksAllGet200ResponseOrderInformationAmountDetails.md) |  | [optional] 
+**lineItems** | [**[PblPaymentLinksAllGet200ResponseOrderInformationLineItems]**](PblPaymentLinksAllGet200ResponseOrderInformationLineItems.md) | List of the line items from the order. | [optional] 
+
+

package/docs/PblPaymentLinksAllGet200ResponseOrderInformationAmountDetails.md

@@ -0,0 +1,11 @@
+# CyberSource.PblPaymentLinksAllGet200ResponseOrderInformationAmountDetails
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**totalAmount** | **String** | Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters. CyberSource truncates the amount to the correct number of decimal places.  **Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12.  **Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths.  If your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen.   #### Card Present Required to include either this field or `orderInformation.lineItems[].unitPrice` for the order.  #### Invoicing / Pay By Link Required for creating a new invoice or payment link.  #### PIN Debit Amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount.  Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests.  #### GPX This field is optional for reversing an authorization or credit; however, for all other processors, these fields are required.  #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request.   #### DCC for First Data Not used.  | [optional] 
+**currency** | **String** | Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)  #### Used by **Authorization** Required field.  **Authorization Reversal** For an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request.  #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase.  For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).  Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests.  #### GPX This field is optional for reversing an authorization or credit.  #### DCC for First Data Your local currency.  #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency.  | [optional] 
+**maxAmount** | **String** | Maximum custom amount allowed for Donation. The customer cannot enter more than maxAmount on payment checkout page. | [optional] 
+**minAmount** | **String** | Minimum custom amount allowed for Donation. The customer cannot enter less than minAmount on payment checkout page. Required for DONATION links. | [optional] 
+
+

package/docs/PblPaymentLinksAllGet200ResponseOrderInformationLineItems.md

@@ -0,0 +1,10 @@
+# CyberSource.PblPaymentLinksAllGet200ResponseOrderInformationLineItems
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**productName** | **String** | For an authorization or capture transaction (`processingOptions.capture` is `true` or `false`), this field is required when `orderInformation.lineItems[].productCode` is not `default` or one of the other values that are related to shipping and/or handling.  #### Tax Calculation Optional field for U.S., Canadian, international tax, and value added taxes.  | [optional] 
+**unitPrice** | **String** | Per-item price of the product. This value for this field cannot be negative.  You must include either this field or the request-level field `orderInformation.amountDetails.totalAmount` in your request.  You can include a decimal point (.), but you cannot include any other special characters. The value is truncated to the correct number of decimal places.  #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either the 1st line item in the order and this field, or the request-level field `orderInformation.amountDetails.totalAmount` in your request.  #### Tax Calculation Required field for U.S., Canadian, international and value added taxes.  #### Zero Amount Authorizations If your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen.  #### Maximum Field Lengths For GPN and JCN Gateway: Decimal (10) All other processors: Decimal (15)  | [optional] 
+**productDescription** | **String** | Brief description of item. | [optional] 
+
+

package/docs/PblPaymentLinksAllGet200ResponseProcessingInformation.md

@@ -0,0 +1,8 @@
+# CyberSource.PblPaymentLinksAllGet200ResponseProcessingInformation
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**linkType** | **String** | linkType defines what type of link you want to create.  Possible Values:   - `PURCHASE`   - `DONATION`  | [optional] 
+
+

package/docs/PblPaymentLinksAllGet200ResponsePurchaseInformation.md

@@ -0,0 +1,9 @@
+# CyberSource.PblPaymentLinksAllGet200ResponsePurchaseInformation
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**purchaseNumber** | **String** | The purchase number | [optional] 
+**paymentLink** | **String** | Returns the link to a purchase or donation link when the status is `ACTIVE`. | [optional] 
+
+

package/docs/PblPaymentLinksAllGet400Response.md

@@ -0,0 +1,12 @@
+# CyberSource.PblPaymentLinksAllGet400Response
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**submitTimeUtc** | **String** | Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ` **Example** `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the time. The `Z` indicates UTC.  Returned by Cybersource for all services.  | [optional] 
+**status** | **String** | The status of the purchase or donation link.  Possible values:   - BADREQUEST    | [optional] 
+**reason** | **String** | The reason of the status.  Possible values: - DUPLICATE_RECORD - ACTION_NOT_ALLOWED - VALIDATION_ERRORS - INVALID_TRANSIENT_TOKEN  | [optional] 
+**message** | **String** | The detail message related to the status and reason listed above. | [optional] 
+**details** | [**[PtsV2PaymentsPost201ResponseErrorInformationDetails]**](PtsV2PaymentsPost201ResponseErrorInformationDetails.md) |  | [optional] 
+
+

package/docs/PblPaymentLinksAllGet404Response.md

@@ -0,0 +1,12 @@
+# CyberSource.PblPaymentLinksAllGet404Response
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**submitTimeUtc** | **String** | Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ` **Example** `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the time. The `Z` indicates UTC.  Returned by Cybersource for all services.  | [optional] 
+**status** | **String** | The status of the purchase or donation link.  Possible values:   - NOTFOUND    | [optional] 
+**reason** | **String** | The reason of the status.  Possible values: - NOTFOUND  | [optional] 
+**message** | **String** | The detail message related to the status and reason listed above. | [optional] 
+**details** | [**[PtsV2PaymentsPost201ResponseErrorInformationDetails]**](PtsV2PaymentsPost201ResponseErrorInformationDetails.md) |  | [optional] 
+
+

package/docs/PblPaymentLinksGet200Response.md

@@ -0,0 +1,14 @@
+# CyberSource.PblPaymentLinksGet200Response
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**links** | [**PblPaymentLinksPost201ResponseLinks**](PblPaymentLinksPost201ResponseLinks.md) |  | [optional] 
+**id** | **String** | An unique identification number generated by Cybersource to identify the submitted request. Returned by all services. It is also appended to the endpoint of the resource. On incremental authorizations, this value with be the same as the identification number returned in the original authorization response.  | [optional] 
+**submitTimeUtc** | **String** | Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ` **Example** `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the time. The `Z` indicates UTC.  Returned by Cybersource for all services.  | [optional] 
+**status** | **String** | The status of the purchase or donation link.  Possible values: - ACTIVE - INACTIVE  | [optional] 
+**processingInformation** | [**Iplv2paymentlinksProcessingInformation**](Iplv2paymentlinksProcessingInformation.md) |  | [optional] 
+**purchaseInformation** | [**PblPaymentLinksPost201ResponsePurchaseInformation**](PblPaymentLinksPost201ResponsePurchaseInformation.md) |  | [optional] 
+**orderInformation** | [**PblPaymentLinksPost201ResponseOrderInformation**](PblPaymentLinksPost201ResponseOrderInformation.md) |  | [optional] 
+
+

package/docs/PblPaymentLinksPost201Response.md

@@ -0,0 +1,14 @@
+# CyberSource.PblPaymentLinksPost201Response
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**links** | [**PblPaymentLinksPost201ResponseLinks**](PblPaymentLinksPost201ResponseLinks.md) |  | [optional] 
+**id** | **String** | An unique identification number generated by Cybersource to identify the submitted request. Returned by all services. It is also appended to the endpoint of the resource. On incremental authorizations, this value with be the same as the identification number returned in the original authorization response.  | [optional] 
+**submitTimeUtc** | **String** | Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ` **Example** `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the time. The `Z` indicates UTC.  Returned by Cybersource for all services.  | [optional] 
+**status** | **String** | The status of the purchase or donation link.  Possible values: - ACTIVE - INACTIVE  | [optional] 
+**processingInformation** | [**Iplv2paymentlinksProcessingInformation**](Iplv2paymentlinksProcessingInformation.md) |  | [optional] 
+**purchaseInformation** | [**PblPaymentLinksPost201ResponsePurchaseInformation**](PblPaymentLinksPost201ResponsePurchaseInformation.md) |  | [optional] 
+**orderInformation** | [**PblPaymentLinksPost201ResponseOrderInformation**](PblPaymentLinksPost201ResponseOrderInformation.md) |  | [optional] 
+
+

package/docs/PblPaymentLinksPost201ResponseLinks.md

@@ -0,0 +1,9 @@
+# CyberSource.PblPaymentLinksPost201ResponseLinks
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**self** | [**PtsV2PaymentsPost201ResponseLinksSelf**](PtsV2PaymentsPost201ResponseLinksSelf.md) |  | [optional] 
+**update** | [**PtsV2PaymentsPost201ResponseLinksSelf**](PtsV2PaymentsPost201ResponseLinksSelf.md) |  | [optional] 
+
+

package/docs/PblPaymentLinksPost201ResponseOrderInformation.md

@@ -0,0 +1,9 @@
+# CyberSource.PblPaymentLinksPost201ResponseOrderInformation
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**amountDetails** | [**PblPaymentLinksAllGet200ResponseOrderInformationAmountDetails**](PblPaymentLinksAllGet200ResponseOrderInformationAmountDetails.md) |  | [optional] 
+**lineItems** | [**[Iplv2paymentlinksOrderInformationLineItems]**](Iplv2paymentlinksOrderInformationLineItems.md) | List of the line items from the order. | [optional] 
+
+

package/docs/PblPaymentLinksPost201ResponsePurchaseInformation.md

@@ -0,0 +1,10 @@
+# CyberSource.PblPaymentLinksPost201ResponsePurchaseInformation
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**purchaseNumber** | **String** | The purchase number | [optional] 
+**createdDate** | **String** | Date and time (UTC) the invoice was created.  Format: YYYY-MM-DDThh:mm:ssZ Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the time. The Z indicates UTC.  | [optional] 
+**paymentLink** | **String** | Returns the link to a purchase or donation link when the status is `ACTIVE`. | [optional] 
+
+

package/docs/PlansApi.md

@@ -66,7 +66,7 @@ No authorization required
 
 Create a Plan
 
-The recurring billing service enables you to manage payment plans and subscriptions for recurring payment schedules. It securely stores your customer's payment information and personal data within secure Visa data centers, reducing storage risks and PCI DSS scope through the use of *Token Management* (*TMS*).  The three key elements of *Cybersource* Recurring Billing are:  -  **Token**: stores customer billing, shipping, and payment details.  -  **Plan**: stores the billing schedule.  -  **Subscription**: combines the token and plan, and defines the subscription start date, name, and description.  The APIs in this section demonstrate the management of the Plans and Subscriptions. For Tokens please refer to [Token Management](#token-management) 
+The recurring billing service enables you to manage payment plans and subscriptions for recurring payment schedules. It securely stores your customer's payment information and personal data within secure Visa data centers, reducing storage risks and PCI DSS scope through the use of *Token Management* (*TMS*).  The three key elements of *Cybersource* Recurring Billing are:  -  **Token**: stores customer billing, shipping, and payment details.  -  **Plan**: stores the billing schedule.  -  **Subscription**: combines the token and plan, and defines the subscription start date, name, and description.  The APIs in this section demonstrate the management of the Plans and Subscriptions. For Tokens please refer to [Token Management](#token-management) The availability of API features for a merchant can depend on the portfolio configuration and may need to be enabled at the portfolio level before they can be added to merchant accounts. 
 
 ### Example
 ```javascript

package/docs/PostDeviceSearchRequestV3.md

@@ -0,0 +1,11 @@
+# CyberSource.PostDeviceSearchRequestV3
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**query** | **String** | The Search Query to retrieve the Terminals.(Example :- serialNumber:456345234 AND readerId:509353f0-86ca-4af4-a1c9-c2702bfd7431  AND terminalId:7854922 AND status:Inactive AND statusChangeReason:Other AND organizationId:London Store) | [optional] 
+**sort** | **String** | terminalCreationDate:desc (default) or serialNumber or terminalUpdationDate | [optional] 
+**offset** | **Number** | The offset or page number. | [optional] 
+**limit** | **Number** | Number of devices to retrieve in one request. | [optional] 
+
+

package/docs/PostPaymentCredentialsRequest.md

@@ -4,5 +4,6 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **paymentCredentialType** | **String** | The type of payment credentials to be returned. By default, payment credentials include network token and cryptogram or dynamic CVV. If \"NETWORK_TOKEN\" is supplied then only network token card number will be returned and no cryptogram or dynamic CVV will be requested. If \"SECURITY_CODE\" is supplied then dynamic CVV will be requested and returned with the network token card number. Dynamic CVV is only supported for Amex and SCOF. If \"CRYPTOGRAM\" is supplied then cryptogram will be requested and returned with the network token card number. Cryptogram is NOT supported for Amex.  Possible Values:   - NETWORK_TOKEN   - SECURITY_CODE   - CRYPTOGRAM  | [optional] 
+**transactionType** | **String** | Specifies the type of transaction for which the network token credentials are required. Possible Values:   - ECOM: Ecommerce transaction. If transactionType is not provided, ECOM is set as the default.   - AFT: Account Funding Transaction. This is only supported for VISA and paymentCredentialType of CRYPTOGRAM.  | [optional] 
 
 

package/docs/PtsV2IncrementalAuthorizationPatch201ResponseErrorInformation.md

@@ -3,7 +3,7 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**reason** | **String** | The reason of the status.  Possible values:   - AVS_FAILED   - CONTACT_PROCESSOR   - EXPIRED_CARD   - PROCESSOR_DECLINED   - INSUFFICIENT_FUND   - STOLEN_LOST_CARD   - ISSUER_UNAVAILABLE   - UNAUTHORIZED_CARD   - CVN_NOT_MATCH   - EXCEEDS_CREDIT_LIMIT   - INVALID_CVN   - BLACKLISTED_CUSTOMER   - SUSPENDED_ACCOUNT   - PAYMENT_REFUSED   - CV_FAILED   - INVALID_ACCOUNT   - GENERAL_DECLINE   - INVALID_MERCHANT_CONFIGURATION   - DECISION_PROFILE_REJECT   - SCORE_EXCEEDS_THRESHOLD   - CONSUMER_AUTHENTICATION_REQUIRED   - ALLOWABLE_PIN_RETRIES_EXCEEDED   - PROCESSOR_ERROR  | [optional] 
+**reason** | **String** | The reason of the status.  Possible values:   - AVS_FAILED   - CONTACT_PROCESSOR   - EXPIRED_CARD   - PROCESSOR_DECLINED   - INSUFFICIENT_FUND   - STOLEN_LOST_CARD   - ISSUER_UNAVAILABLE   - UNAUTHORIZED_CARD   - CVN_NOT_MATCH   - EXCEEDS_CREDIT_LIMIT   - INVALID_CVN   - BLOCKED_BY_CARDHOLDER   - BLACKLISTED_CUSTOMER   - SUSPENDED_ACCOUNT   - PAYMENT_REFUSED   - CV_FAILED   - INVALID_ACCOUNT   - GENERAL_DECLINE   - INVALID_MERCHANT_CONFIGURATION   - DECISION_PROFILE_REJECT   - SCORE_EXCEEDS_THRESHOLD   - CONSUMER_AUTHENTICATION_REQUIRED   - ALLOWABLE_PIN_RETRIES_EXCEEDED   - PROCESSOR_ERROR  | [optional] 
 **message** | **String** | The detail message related to the status and reason listed above. | [optional] 
 **details** | [**[PtsV2PaymentsPost201ResponseErrorInformationDetails]**](PtsV2PaymentsPost201ResponseErrorInformationDetails.md) |  | [optional] 
 

package/docs/PtsV2PaymentsOrderPost201ResponseOrderInformationAmountDetails.md

@@ -3,7 +3,7 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**totalAmount** | **String** | Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters. CyberSource truncates the amount to the correct number of decimal places.  **Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12.  **Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths.  If your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen.   #### Card Present Required to include either this field or `orderInformation.lineItems[].unitPrice` for the order.  #### Invoicing Required for creating a new invoice.  #### PIN Debit Amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount.  Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests.  #### GPX This field is optional for reversing an authorization or credit; however, for all other processors, these fields are required.  #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request.   #### DCC for First Data Not used.  | [optional] 
+**totalAmount** | **String** | Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters. CyberSource truncates the amount to the correct number of decimal places.  **Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12.  **Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths.  If your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen.   #### Card Present Required to include either this field or `orderInformation.lineItems[].unitPrice` for the order.  #### Invoicing / Pay By Link Required for creating a new invoice or payment link.  #### PIN Debit Amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount.  Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests.  #### GPX This field is optional for reversing an authorization or credit; however, for all other processors, these fields are required.  #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request.   #### DCC for First Data Not used.  | [optional] 
 **currency** | **String** | Currency used for the order  | [optional]