first_data_gateway 1.9.0 → 1.13.0

data/docs/ManagedRedirectPaymentMethodPaymentDetails.md

@@ -0,0 +1,19 @@
+# OpenapiClient::ManagedRedirectPaymentMethodPaymentDetails
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**key** | **String** |  | [optional] 
+**value** | **String** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::ManagedRedirectPaymentMethodPaymentDetails.new(key: null,
+                                 value: null)
+```
+
+

data/docs/ManagedRedirectRequest.md

@@ -0,0 +1,29 @@
+# OpenapiClient::ManagedRedirectRequest
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**transaction_amount** | [**Amount**](Amount.md) |  | 
+**store_id** | **String** | An optional Outlet ID for clients that support multiple stores in the same developer app. | [optional] 
+**merchant_transaction_id** | **String** | The unique merchant transaction ID from the request, if supplied. | [optional] 
+**transaction_type** | [**ManagedRedirectTransactionType**](ManagedRedirectTransactionType.md) |  | 
+**order** | [**Order**](Order.md) |  | [optional] 
+**redirect_attributes** | [**RedirectAttributes**](RedirectAttributes.md) |  | [optional] 
+**payment_method** | [**Object**](.md) | Various payment methods the Gateway supports. Abstract class, do not use this class directly, use one of its children. | 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::ManagedRedirectRequest.new(transaction_amount: null,
+                                 store_id: 12345500000,
+                                 merchant_transaction_id: lsk23532djljff3,
+                                 transaction_type: null,
+                                 order: null,
+                                 redirect_attributes: null,
+                                 payment_method: null)
+```
+
+

data/docs/ManagedRedirectResponse.md

@@ -0,0 +1,29 @@
+# OpenapiClient::ManagedRedirectResponse
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**client_request_id** | **String** | Echoes back the value in the request header for tracking. | [optional] 
+**api_trace_id** | **String** | Request identifier in API, can be used to request logs from the support team. | [optional] 
+**response_type** | [**ResponseType**](ResponseType.md) |  | [optional] 
+**request_status** | **String** | The status of the request. | [optional] 
+**order_id** | **String** | Note - Client Order ID if supplied by client which should not contain any special characters or spaces. If not supplied by client, IPG will generate. The first 12 alphanumeric digits are passed down to Fiserv Enterprise reporting tool, Clientline and Data File Manager (DFM). | [optional] 
+**redirect_url** | **String** | URL for embedded payment link. | [optional] 
+**transaction_id** | **String** | ID code from the transaction. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::ManagedRedirectResponse.new(client_request_id: 30dd879c-ee2f-11db-8314-0800200c9a66,
+                                 api_trace_id: rrt-0bd552c12342d3448-b-ea-1142-12938318-7,
+                                 response_type: null,
+                                 request_status: SUCCESS,
+                                 order_id: 123456,
+                                 redirect_url: https://api.firstdata.com/connect/gateway/processing?storename=123456789&oid=R-96cdbaa4-c22e-4598-a2f1-c2b5fed79ef1&redirectRequestId=d3eb74fe-cf63-47e1-b89f-52ba0cc7965c,
+                                 transaction_id: 123978432)
+```
+
+

data/docs/ManagedRedirectTransactionType.md

@@ -0,0 +1,16 @@
+# OpenapiClient::ManagedRedirectTransactionType
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::ManagedRedirectTransactionType.new()
+```
+
+

data/docs/Order.md

@@ -4,15 +4,18 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**order_id** | **String** | Client Order ID if supplied by client. | [optional] 
+**order_id** | **String** | Note - Client Order ID if supplied by client. If not supplied by client, IPG will generate. The first 12 alphanumeric digits are passed down to Fiserv Enterprise reporting tool, Clientline and Data File Manager (DFM). | [optional] 
 **billing** | [**Billing**](Billing.md) |  | [optional] 
 **shipping** | [**Shipping**](Shipping.md) |  | [optional] 
 **industry_specific_extensions** | [**IndustrySpecificExtensions**](IndustrySpecificExtensions.md) |  | [optional] 
 **purchase_card** | [**PurchaseCards**](PurchaseCards.md) |  | [optional] 
 **installment_options** | [**InstallmentOptions**](InstallmentOptions.md) |  | [optional] 
+**revolving_options** | [**RevolvingOptions**](RevolvingOptions.md) |  | [optional] 
+**stand_in_details** | [**StandInDetails**](StandInDetails.md) |  | [optional] 
 **soft_descriptor** | [**SoftDescriptor**](SoftDescriptor.md) |  | [optional] 
 **additional_details** | [**AdditionalDetails**](AdditionalDetails.md) |  | [optional] 
 **bancontact_qr** | [**BancontactQR**](BancontactQR.md) |  | [optional] 
+**client_locale** | [**ClientLocale**](ClientLocale.md) |  | [optional] 
 
 ## Code Sample
 
@@ -25,9 +28,12 @@ instance = OpenapiClient::Order.new(order_id: ABC12345,
                                  industry_specific_extensions: null,
                                  purchase_card: null,
                                  installment_options: null,
+                                 revolving_options: null,
+                                 stand_in_details: null,
                                  soft_descriptor: null,
                                  additional_details: null,
-                                 bancontact_qr: null)
+                                 bancontact_qr: null,
+                                 client_locale: null)
 ```
 
 

data/docs/OrderApi.md

@@ -92,7 +92,7 @@ client_request_id = 'client_request_id_example' # String | A client-generated ID
 api_key = 'api_key_example' # String | Key given to merchant after boarding associating their requests with the appropriate app in Apigee.
 timestamp = 56 # Integer | Epoch timestamp in milliseconds in the request from a client system. Used for Message Signature generation and time limit (5 mins).
 order_id = 'order_id_example' # String | Gateway order identifier as returned in the parameter orderId.
-secondary_transaction = OpenapiClient::SecondaryTransaction.new # SecondaryTransaction | Accepted request types: PostAuthTransaction, VoidTransaction, VoidPreAuthTransactions, ReturnTransaction, AchPostAuthTransaction, AchVoidTransaction and AchReturnTransaction.
+secondary_transaction = OpenapiClient::SecondaryTransaction.new # SecondaryTransaction | Accepted request types: PostAuthTransaction, VoidTransaction, VoidPreAuthTransactions, ReturnTransaction, AchPostAuthTransaction, AchVoidTransaction, AchReturnTransaction and PreAuthSecondaryTransaction.
 opts = {
   message_signature: 'message_signature_example', # String | Used to ensure the request has not been tampered with during transmission. The Message-Signature is the Base64 encoded HMAC hash (SHA256 algorithm with the API Secret as the key.) For more information, refer to the supporting documentation on the Developer Portal.
   region: 'region_example' # String | Indicates the region where the client wants the transaction to be processed. This will override the default processing region identified for the client. Available options are argentina, brazil, germany, india and northamerica. Region specific store setup and APIGEE boarding is required in order to use an alternate region for processing.
@@ -117,7 +117,7 @@ Name | Type | Description  | Notes
  **api_key** | **String**| Key given to merchant after boarding associating their requests with the appropriate app in Apigee. | 
  **timestamp** | **Integer**| Epoch timestamp in milliseconds in the request from a client system. Used for Message Signature generation and time limit (5 mins). | 
  **order_id** | **String**| Gateway order identifier as returned in the parameter orderId. | 
- **secondary_transaction** | [**SecondaryTransaction**](SecondaryTransaction.md)| Accepted request types: PostAuthTransaction, VoidTransaction, VoidPreAuthTransactions, ReturnTransaction, AchPostAuthTransaction, AchVoidTransaction and AchReturnTransaction. | 
+ **secondary_transaction** | [**SecondaryTransaction**](SecondaryTransaction.md)| Accepted request types: PostAuthTransaction, VoidTransaction, VoidPreAuthTransactions, ReturnTransaction, AchPostAuthTransaction, AchVoidTransaction, AchReturnTransaction and PreAuthSecondaryTransaction. | 
  **message_signature** | **String**| Used to ensure the request has not been tampered with during transmission. The Message-Signature is the Base64 encoded HMAC hash (SHA256 algorithm with the API Secret as the key.) For more information, refer to the supporting documentation on the Developer Portal. | [optional] 
  **region** | **String**| Indicates the region where the client wants the transaction to be processed. This will override the default processing region identified for the client. Available options are argentina, brazil, germany, india and northamerica. Region specific store setup and APIGEE boarding is required in order to use an alternate region for processing. | [optional] 
 

data/docs/OrderErrorResponse.md

@@ -7,7 +7,7 @@ Name | Type | Description | Notes
 **client_request_id** | **String** | Echoes back the value in the request header for tracking. | [optional] 
 **api_trace_id** | **String** | Request identifier in API, can be used to request logs from the support team. | [optional] 
 **response_type** | [**ResponseType**](ResponseType.md) |  | [optional] 
-**order_id** | **String** | Client order ID if supplied by client, otherwise the order ID. | [optional] 
+**order_id** | **String** | Note - Client Order ID if supplied by client. If not supplied by client, IPG will generate. The first 12 alphanumeric digits are passed down to Fiserv Enterprise reporting tool, Clientline and Data File Manager (DFM). | [optional] 
 **billing** | [**Billing**](Billing.md) |  | [optional] 
 **shipping** | [**Shipping**](Shipping.md) |  | [optional] 
 **transactions** | [**Array<TransactionResponse>**](TransactionResponse.md) | Required for some payment methods (for example, Klarna). | [optional] 

data/docs/OrderResponse.md

@@ -7,7 +7,7 @@ Name | Type | Description | Notes
 **client_request_id** | **String** | Echoes back the value in the request header for tracking. | [optional] 
 **api_trace_id** | **String** | Request identifier in API, can be used to request logs from the support team. | [optional] 
 **response_type** | [**ResponseType**](ResponseType.md) |  | [optional] 
-**order_id** | **String** | Client order ID if supplied by client, otherwise the order ID. | [optional] 
+**order_id** | **String** | Note - Client Order ID if supplied by client. If not supplied by client, IPG will generate. The first 12 alphanumeric digits are passed down to Fiserv Enterprise reporting tool, Clientline and Data File Manager (DFM). | [optional] 
 **billing** | [**Billing**](Billing.md) |  | [optional] 
 **shipping** | [**Shipping**](Shipping.md) |  | [optional] 
 **transactions** | [**Array<TransactionResponse>**](TransactionResponse.md) | Required for some payment methods (for example, Klarna). | [optional] 

data/docs/PaymentApi.md

@@ -31,7 +31,7 @@ client_request_id = 'client_request_id_example' # String | A client-generated ID
 api_key = 'api_key_example' # String | Key given to merchant after boarding associating their requests with the appropriate app in Apigee.
 timestamp = 56 # Integer | Epoch timestamp in milliseconds in the request from a client system. Used for Message Signature generation and time limit (5 mins).
 transaction_id = 'transaction_id_example' # String | Gateway transaction identifier as returned in the parameter ipgTransactionId or merchantTransactionId.
-authentication_update_request = OpenapiClient::AuthenticationUpdateRequest.new # AuthenticationUpdateRequest | Accepted request types: Secure3D10AuthenticationUpdateRequest, Secure3D21AuthenticationUpdateRequest, and UnionPayAuthenticationUpdateRequest.
+authentication_update_request = OpenapiClient::AuthenticationUpdateRequest.new # AuthenticationUpdateRequest | Accepted request types: Secure3DAuthenticationUpdateRequest, Secure3D10AuthenticationUpdateRequest, Secure3D21AuthenticationUpdateRequest and UnionPayAuthenticationUpdateRequest.
 opts = {
   message_signature: 'message_signature_example', # String | Used to ensure the request has not been tampered with during transmission. The Message-Signature is the Base64 encoded HMAC hash (SHA256 algorithm with the API Secret as the key.) For more information, refer to the supporting documentation on the Developer Portal.
   region: 'region_example' # String | Indicates the region where the client wants the transaction to be processed. This will override the default processing region identified for the client. Available options are argentina, brazil, germany, india and northamerica. Region specific store setup and APIGEE boarding is required in order to use an alternate region for processing.
@@ -56,7 +56,7 @@ Name | Type | Description  | Notes
  **api_key** | **String**| Key given to merchant after boarding associating their requests with the appropriate app in Apigee. | 
  **timestamp** | **Integer**| Epoch timestamp in milliseconds in the request from a client system. Used for Message Signature generation and time limit (5 mins). | 
  **transaction_id** | **String**| Gateway transaction identifier as returned in the parameter ipgTransactionId or merchantTransactionId. | 
- **authentication_update_request** | [**AuthenticationUpdateRequest**](AuthenticationUpdateRequest.md)| Accepted request types: Secure3D10AuthenticationUpdateRequest, Secure3D21AuthenticationUpdateRequest, and UnionPayAuthenticationUpdateRequest. | 
+ **authentication_update_request** | [**AuthenticationUpdateRequest**](AuthenticationUpdateRequest.md)| Accepted request types: Secure3DAuthenticationUpdateRequest, Secure3D10AuthenticationUpdateRequest, Secure3D21AuthenticationUpdateRequest and UnionPayAuthenticationUpdateRequest. | 
  **message_signature** | **String**| Used to ensure the request has not been tampered with during transmission. The Message-Signature is the Base64 encoded HMAC hash (SHA256 algorithm with the API Secret as the key.) For more information, refer to the supporting documentation on the Developer Portal. | [optional] 
  **region** | **String**| Indicates the region where the client wants the transaction to be processed. This will override the default processing region identified for the client. Available options are argentina, brazil, germany, india and northamerica. Region specific store setup and APIGEE boarding is required in order to use an alternate region for processing. | [optional] 
 
@@ -93,7 +93,7 @@ content_type = 'application/json' # String | Content type.
 client_request_id = 'client_request_id_example' # String | A client-generated ID for request tracking and signature creation, unique per request.  This is also used for idempotency control. We recommend 128-bit UUID format.
 api_key = 'api_key_example' # String | Key given to merchant after boarding associating their requests with the appropriate app in Apigee.
 timestamp = 56 # Integer | Epoch timestamp in milliseconds in the request from a client system. Used for Message Signature generation and time limit (5 mins).
-primary_transaction = OpenapiClient::PrimaryTransaction.new # PrimaryTransaction | Accepted request types: AliPaySaleTransaction, ChinaPnRSaleTransaction, PaymentCardCreditTransaction, PaymentCardForcedTicketTransaction, PaymentCardSaleTransaction, PaymentCardPreAuthTransaction, PaymentCardPayerAuthTransaction, PaymentCardDisbursementTransaction, PaymentTokenCreditTransaction, PaymentTokenPreAuthTransaction, PaymentTokenSaleTransaction, PaymentTokenDisbursementTransaction, PaypalCreditTransaction, SepaSaleTransaction, WalletSaleTransaction, and WalletPreAuthTransaction, PaymentDeviceSaleTransaction, PaymentDevicePreAuthTransaction, PaymentDeviceCreditTransaction, PaymentDeviceDisbursementTransaction, AchPreAuthTransaction, AchSaleTransaction, AchCreditTransaction.
+primary_transaction = OpenapiClient::PrimaryTransaction.new # PrimaryTransaction | Accepted request types: AliPaySaleTransaction, ChinaPnRSaleTransaction, PaymentCardCreditTransaction, PaymentCardForcedTicketTransaction, PaymentCardSaleTransaction, PaymentCardPreAuthTransaction, PaymentCardPayerAuthTransaction, PaymentCardDisbursementTransaction, PaymentTokenCreditTransaction, PaymentTokenPreAuthTransaction, PaymentTokenSaleTransaction, PaymentTokenDisbursementTransaction, PaypalCreditTransaction, SepaSaleTransaction, SepaCreditTransaction, WalletSaleTransaction, and WalletPreAuthTransaction, PaymentDeviceSaleTransaction, PaymentDevicePreAuthTransaction, PaymentDeviceCreditTransaction, PaymentDeviceDisbursementTransaction, AchPreAuthTransaction, AchSaleTransaction, AchCreditTransaction.
 opts = {
   message_signature: 'message_signature_example', # String | Used to ensure the request has not been tampered with during transmission. The Message-Signature is the Base64 encoded HMAC hash (SHA256 algorithm with the API Secret as the key.) For more information, refer to the supporting documentation on the Developer Portal.
   region: 'region_example' # String | Indicates the region where the client wants the transaction to be processed. This will override the default processing region identified for the client. Available options are argentina, brazil, germany, india and northamerica. Region specific store setup and APIGEE boarding is required in order to use an alternate region for processing.
@@ -117,7 +117,7 @@ Name | Type | Description  | Notes
  **client_request_id** | **String**| A client-generated ID for request tracking and signature creation, unique per request.  This is also used for idempotency control. We recommend 128-bit UUID format. | 
  **api_key** | **String**| Key given to merchant after boarding associating their requests with the appropriate app in Apigee. | 
  **timestamp** | **Integer**| Epoch timestamp in milliseconds in the request from a client system. Used for Message Signature generation and time limit (5 mins). | 
- **primary_transaction** | [**PrimaryTransaction**](PrimaryTransaction.md)| Accepted request types: AliPaySaleTransaction, ChinaPnRSaleTransaction, PaymentCardCreditTransaction, PaymentCardForcedTicketTransaction, PaymentCardSaleTransaction, PaymentCardPreAuthTransaction, PaymentCardPayerAuthTransaction, PaymentCardDisbursementTransaction, PaymentTokenCreditTransaction, PaymentTokenPreAuthTransaction, PaymentTokenSaleTransaction, PaymentTokenDisbursementTransaction, PaypalCreditTransaction, SepaSaleTransaction, WalletSaleTransaction, and WalletPreAuthTransaction, PaymentDeviceSaleTransaction, PaymentDevicePreAuthTransaction, PaymentDeviceCreditTransaction, PaymentDeviceDisbursementTransaction, AchPreAuthTransaction, AchSaleTransaction, AchCreditTransaction. | 
+ **primary_transaction** | [**PrimaryTransaction**](PrimaryTransaction.md)| Accepted request types: AliPaySaleTransaction, ChinaPnRSaleTransaction, PaymentCardCreditTransaction, PaymentCardForcedTicketTransaction, PaymentCardSaleTransaction, PaymentCardPreAuthTransaction, PaymentCardPayerAuthTransaction, PaymentCardDisbursementTransaction, PaymentTokenCreditTransaction, PaymentTokenPreAuthTransaction, PaymentTokenSaleTransaction, PaymentTokenDisbursementTransaction, PaypalCreditTransaction, SepaSaleTransaction, SepaCreditTransaction, WalletSaleTransaction, and WalletPreAuthTransaction, PaymentDeviceSaleTransaction, PaymentDevicePreAuthTransaction, PaymentDeviceCreditTransaction, PaymentDeviceDisbursementTransaction, AchPreAuthTransaction, AchSaleTransaction, AchCreditTransaction. | 
  **message_signature** | **String**| Used to ensure the request has not been tampered with during transmission. The Message-Signature is the Base64 encoded HMAC hash (SHA256 algorithm with the API Secret as the key.) For more information, refer to the supporting documentation on the Developer Portal. | [optional] 
  **region** | **String**| Indicates the region where the client wants the transaction to be processed. This will override the default processing region identified for the client. Available options are argentina, brazil, germany, india and northamerica. Region specific store setup and APIGEE boarding is required in order to use an alternate region for processing. | [optional] 
 
@@ -155,7 +155,7 @@ client_request_id = 'client_request_id_example' # String | A client-generated ID
 api_key = 'api_key_example' # String | Key given to merchant after boarding associating their requests with the appropriate app in Apigee.
 timestamp = 56 # Integer | Epoch timestamp in milliseconds in the request from a client system. Used for Message Signature generation and time limit (5 mins).
 transaction_id = 'transaction_id_example' # String | Gateway transaction identifier as returned in the parameter ipgTransactionId or merchantTransactionId.
-secondary_transaction = OpenapiClient::SecondaryTransaction.new # SecondaryTransaction | Accepted request types: PostAuthTransaction, VoidTransaction, VoidPreAuthTransactions, ReturnTransaction, AchPostAuthTransaction, AchVoidTransaction and AchReturnTransaction.
+secondary_transaction = OpenapiClient::SecondaryTransaction.new # SecondaryTransaction | Accepted request types: PostAuthTransaction, VoidTransaction, VoidPreAuthTransactions, ReturnTransaction, AchPostAuthTransaction, AchVoidTransaction, AchReturnTransaction and PreAuthSecondaryTransaction.
 opts = {
   message_signature: 'message_signature_example', # String | Used to ensure the request has not been tampered with during transmission. The Message-Signature is the Base64 encoded HMAC hash (SHA256 algorithm with the API Secret as the key.) For more information, refer to the supporting documentation on the Developer Portal.
   region: 'region_example', # String | Indicates the region where the client wants the transaction to be processed. This will override the default processing region identified for the client. Available options are argentina, brazil, germany, india and northamerica. Region specific store setup and APIGEE boarding is required in order to use an alternate region for processing.
@@ -181,7 +181,7 @@ Name | Type | Description  | Notes
  **api_key** | **String**| Key given to merchant after boarding associating their requests with the appropriate app in Apigee. | 
  **timestamp** | **Integer**| Epoch timestamp in milliseconds in the request from a client system. Used for Message Signature generation and time limit (5 mins). | 
  **transaction_id** | **String**| Gateway transaction identifier as returned in the parameter ipgTransactionId or merchantTransactionId. | 
- **secondary_transaction** | [**SecondaryTransaction**](SecondaryTransaction.md)| Accepted request types: PostAuthTransaction, VoidTransaction, VoidPreAuthTransactions, ReturnTransaction, AchPostAuthTransaction, AchVoidTransaction and AchReturnTransaction. | 
+ **secondary_transaction** | [**SecondaryTransaction**](SecondaryTransaction.md)| Accepted request types: PostAuthTransaction, VoidTransaction, VoidPreAuthTransactions, ReturnTransaction, AchPostAuthTransaction, AchVoidTransaction, AchReturnTransaction and PreAuthSecondaryTransaction. | 
  **message_signature** | **String**| Used to ensure the request has not been tampered with during transmission. The Message-Signature is the Base64 encoded HMAC hash (SHA256 algorithm with the API Secret as the key.) For more information, refer to the supporting documentation on the Developer Portal. | [optional] 
  **region** | **String**| Indicates the region where the client wants the transaction to be processed. This will override the default processing region identified for the client. Available options are argentina, brazil, germany, india and northamerica. Region specific store setup and APIGEE boarding is required in order to use an alternate region for processing. | [optional] 
  **store_id** | **String**| An optional outlet ID for clients that support multiple stores in the same developer app. | [optional] 

data/docs/{RemoveFraudBlockedItemsResponse.md → PaymentBrandResponse.md}

@@ -1,4 +1,4 @@
-# OpenapiClient::RemoveFraudBlockedItemsResponse
+# OpenapiClient::PaymentBrandResponse
 
 ## Properties
 
@@ -7,17 +7,17 @@ Name | Type | Description | Notes
 **client_request_id** | **String** | Echoes back the value in the request header for tracking. | [optional] 
 **api_trace_id** | **String** | Request identifier in API, can be used to request logs from the support team. | [optional] 
 **response_type** | [**ResponseType**](ResponseType.md) |  | [optional] 
-**status** | **String** | Status from delete fraud blocked items operation. | [optional] 
+**brands** | **Array<String>** |  | [optional] 
 
 ## Code Sample
 
 ```ruby
 require 'OpenapiClient'
 
-instance = OpenapiClient::RemoveFraudBlockedItemsResponse.new(client_request_id: 30dd879c-ee2f-11db-8314-0800200c9a66,
+instance = OpenapiClient::PaymentBrandResponse.new(client_request_id: 30dd879c-ee2f-11db-8314-0800200c9a66,
                                  api_trace_id: rrt-0bd552c12342d3448-b-ea-1142-12938318-7,
                                  response_type: null,
-                                 status: SUCCESS. Fraud settings was updated successfully.)
+                                 brands: null)
 ```
 
 

data/docs/PaymentCard.md

@@ -8,7 +8,7 @@ Name | Type | Description | Notes
 **expiry_date** | [**Expiration**](Expiration.md) |  | [optional] 
 **security_code** | **String** | Card verification value/number. | [optional] 
 **card_function** | [**CardFunction**](CardFunction.md) |  | [optional] 
-**cardholder_name** | **String** | Name of the cardholder. | [optional] 
+**cardholder_name** | **String** | Name of the cardholder. Note - Only supported with request payload. | [optional] 
 **bin** | **String** | The payment card BIN. | [optional] 
 **last4** | **String** | The last 4 numbers of a payment card. | [optional] 
 **brand** | **String** | Required only if using dual branded card. | [optional] 

data/docs/PaymentCardCreditTransactionAllOf.md

@@ -0,0 +1,19 @@
+# OpenapiClient::PaymentCardCreditTransactionAllOf
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**payment_method** | [**PaymentCardPaymentMethod**](PaymentCardPaymentMethod.md) |  | 
+**currency_conversion** | [**CurrencyConversion**](CurrencyConversion.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::PaymentCardCreditTransactionAllOf.new(payment_method: null,
+                                 currency_conversion: null)
+```
+
+

data/docs/PaymentCardPayerAuthTransaction.md

@@ -6,6 +6,8 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **payment_method** | [**PaymentCardPaymentMethod**](PaymentCardPaymentMethod.md) |  | 
 **currency_conversion** | [**CurrencyConversion**](CurrencyConversion.md) |  | [optional] 
+**authentication_request** | [**AuthenticationRequest**](AuthenticationRequest.md) |  | [optional] 
+**authentication_result** | [**AuthenticationResult**](AuthenticationResult.md) |  | [optional] 
 
 ## Code Sample
 
@@ -13,7 +15,9 @@ Name | Type | Description | Notes
 require 'OpenapiClient'
 
 instance = OpenapiClient::PaymentCardPayerAuthTransaction.new(payment_method: null,
-                                 currency_conversion: null)
+                                 currency_conversion: null,
+                                 authentication_request: null,
+                                 authentication_result: null)
 ```
 
 

data/docs/PaymentCardPayerAuthTransactionAllOf.md

@@ -6,6 +6,8 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **payment_method** | [**PaymentCardPaymentMethod**](PaymentCardPaymentMethod.md) |  | 
 **currency_conversion** | [**CurrencyConversion**](CurrencyConversion.md) |  | [optional] 
+**authentication_request** | [**AuthenticationRequest**](AuthenticationRequest.md) |  | [optional] 
+**authentication_result** | [**AuthenticationResult**](AuthenticationResult.md) |  | [optional] 
 
 ## Code Sample
 
@@ -13,7 +15,9 @@ Name | Type | Description | Notes
 require 'OpenapiClient'
 
 instance = OpenapiClient::PaymentCardPayerAuthTransactionAllOf.new(payment_method: null,
-                                 currency_conversion: null)
+                                 currency_conversion: null,
+                                 authentication_request: null,
+                                 authentication_result: null)
 ```
 
 

data/docs/PaymentCardPreAuthTransaction.md

@@ -4,7 +4,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**payment_method** | [**PaymentCardPaymentMethod**](PaymentCardPaymentMethod.md) |  | 
+**payment_method** | [**PaymentCardPaymentMethod**](PaymentCardPaymentMethod.md) |  | [optional] 
 **stored_credentials** | [**StoredCredential**](StoredCredential.md) |  | [optional] 
 **create_token** | [**CreatePaymentToken**](CreatePaymentToken.md) |  | [optional] 
 **split_shipment** | [**SplitShipment**](SplitShipment.md) |  | [optional] 

data/docs/PaymentCardPreAuthTransactionAllOf.md

@@ -4,7 +4,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**payment_method** | [**PaymentCardPaymentMethod**](PaymentCardPaymentMethod.md) |  | 
+**payment_method** | [**PaymentCardPaymentMethod**](PaymentCardPaymentMethod.md) |  | [optional] 
 **stored_credentials** | [**StoredCredential**](StoredCredential.md) |  | [optional] 
 **create_token** | [**CreatePaymentToken**](CreatePaymentToken.md) |  | [optional] 
 **split_shipment** | [**SplitShipment**](SplitShipment.md) |  | [optional] 

data/docs/PaymentCardSaleTransaction.md

@@ -4,7 +4,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**payment_method** | [**PaymentCardPaymentMethod**](PaymentCardPaymentMethod.md) |  | 
+**payment_method** | [**PaymentCardPaymentMethod**](PaymentCardPaymentMethod.md) |  | [optional] 
 **stored_credentials** | [**StoredCredential**](StoredCredential.md) |  | [optional] 
 **settlement_split** | [**Array<SubMerchantSplit>**](SubMerchantSplit.md) | Settle with multiple sub-merchants, sale and preAuth only. | [optional] 
 **create_token** | [**CreatePaymentToken**](CreatePaymentToken.md) |  | [optional] 

data/docs/PaymentCardSaleTransactionAllOf.md

@@ -4,7 +4,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**payment_method** | [**PaymentCardPaymentMethod**](PaymentCardPaymentMethod.md) |  | 
+**payment_method** | [**PaymentCardPaymentMethod**](PaymentCardPaymentMethod.md) |  | [optional] 
 **stored_credentials** | [**StoredCredential**](StoredCredential.md) |  | [optional] 
 **settlement_split** | [**Array<SubMerchantSplit>**](SubMerchantSplit.md) | Settle with multiple sub-merchants, sale and preAuth only. | [optional] 
 **create_token** | [**CreatePaymentToken**](CreatePaymentToken.md) |  | [optional] 

data/docs/PaymentSchedulesErrorResponse.md

@@ -8,7 +8,7 @@ Name | Type | Description | Notes
 **api_trace_id** | **String** | Request identifier in API, can be used to request logs from the support team. | [optional] 
 **response_type** | [**ResponseType**](ResponseType.md) |  | [optional] 
 **request_status** | **String** | Result of requested operation. If it's anything other than 'SUCCESS', please refer to 400s HTTP error codes or decline. See Error object for details. | [optional] 
-**order_id** | **String** | Client order ID if supplied by client, otherwise the order ID. | [optional] 
+**order_id** | **String** | Note - Client Order ID if supplied by client. If not supplied by client, IPG will generate. The first 12 alphanumeric digits are passed down to Fiserv Enterprise reporting tool, Clientline and Data File Manager (DFM). | [optional] 
 **transaction_response** | [**TransactionResponse**](TransactionResponse.md) |  | [optional] 
 **error** | [**Error**](Error.md) |  | [optional] 
 

data/docs/PaymentSchedulesRequest.md

@@ -16,7 +16,7 @@ Name | Type | Description | Notes
 **frequency** | [**Frequency**](Frequency.md) |  | 
 **transaction_amount** | [**Amount**](Amount.md) |  | 
 **client_locale** | [**ClientLocale**](ClientLocale.md) |  | [optional] 
-**order_id** | **String** | Client order ID if supplied by client. | [optional] 
+**order_id** | **String** | Note - Client Order ID if supplied by client. If not supplied by client, IPG will generate. The first 12 alphanumeric digits are passed down to Fiserv Enterprise reporting tool, Clientline and Data File Manager (DFM). | [optional] 
 **billing** | [**Billing**](Billing.md) |  | [optional] 
 **shipping** | [**Shipping**](Shipping.md) |  | [optional] 
 **comments** | **String** | User supplied comments. | [optional] 

data/docs/PaymentSchedulesResponse.md

@@ -8,7 +8,7 @@ Name | Type | Description | Notes
 **api_trace_id** | **String** | Request identifier in API, can be used to request logs from the support team. | [optional] 
 **response_type** | [**ResponseType**](ResponseType.md) |  | [optional] 
 **request_status** | **String** | Result of requested operation. If it's anything other than 'SUCCESS', please refer to 400s HTTP error codes or decline. See Error object for details. | [optional] 
-**order_id** | **String** | Client order ID if supplied by client, otherwise the order ID. | [optional] 
+**order_id** | **String** | Note - Client Order ID if supplied by client. If not supplied by client, IPG will generate. The first 12 alphanumeric digits are passed down to Fiserv Enterprise reporting tool, Clientline and Data File Manager (DFM). | [optional] 
 **transaction_response** | [**TransactionResponse**](TransactionResponse.md) |  | [optional] 
 
 ## Code Sample

data/docs/{FontFace.md → PaymentStepRequest.md}

@@ -1,4 +1,4 @@
-# OpenapiClient::FontFace
+# OpenapiClient::PaymentStepRequest
 
 ## Properties
 
@@ -10,7 +10,7 @@ Name | Type | Description | Notes
 ```ruby
 require 'OpenapiClient'
 
-instance = OpenapiClient::FontFace.new()
+instance = OpenapiClient::PaymentStepRequest.new()
 ```
 
 

data/docs/{ConnectMode.md → PaymentStepResponse.md}

@@ -1,4 +1,4 @@
-# OpenapiClient::ConnectMode
+# OpenapiClient::PaymentStepResponse
 
 ## Properties
 
@@ -10,7 +10,7 @@ Name | Type | Description | Notes
 ```ruby
 require 'OpenapiClient'
 
-instance = OpenapiClient::ConnectMode.new()
+instance = OpenapiClient::PaymentStepResponse.new()
 ```
 
 

data/docs/PaymentTokenizationErrorResponse.md

@@ -14,9 +14,10 @@ Name | Type | Description | Notes
 **payment_token** | [**PaymentTokenDetails**](PaymentTokenDetails.md) |  | [optional] 
 **payment_card** | [**PaymentCard**](PaymentCard.md) |  | [optional] 
 **processor** | [**ProcessorData**](ProcessorData.md) |  | [optional] 
-**order_id** | **String** | Client order ID if supplied by client, otherwise the order ID. | [optional] 
+**order_id** | **String** | Note - Client Order ID if supplied by client. If not supplied by client, IPG will generate. The first 12 alphanumeric digits are passed down to Fiserv Enterprise reporting tool, Clientline and Data File Manager (DFM). | [optional] 
 **ipg_transaction_id** | **String** | The response transaction ID. | [optional] 
 **merchant_transaction_id** | **String** | The unique merchant transaction ID from the request header, if supplied. | [optional] 
+**additional_response_data** | [**AdditionalResponseData**](AdditionalResponseData.md) |  | [optional] 
 **error** | [**Error**](Error.md) |  | [optional] 
 
 ## Code Sample
@@ -37,6 +38,7 @@ instance = OpenapiClient::PaymentTokenizationErrorResponse.new(client_request_id
                                  order_id: R-44df6542-ae0b-4415-88e8-7f3e62cc9e5d,
                                  ipg_transaction_id: 838916029301,
                                  merchant_transaction_id: lsk23532djljff3,
+                                 additional_response_data: null,
                                  error: null)
 ```
 

data/docs/PaymentTokenizationResponse.md

@@ -14,9 +14,10 @@ Name | Type | Description | Notes
 **payment_token** | [**PaymentTokenDetails**](PaymentTokenDetails.md) |  | [optional] 
 **payment_card** | [**PaymentCard**](PaymentCard.md) |  | [optional] 
 **processor** | [**ProcessorData**](ProcessorData.md) |  | [optional] 
-**order_id** | **String** | Client order ID if supplied by client, otherwise the order ID. | [optional] 
+**order_id** | **String** | Note - Client Order ID if supplied by client. If not supplied by client, IPG will generate. The first 12 alphanumeric digits are passed down to Fiserv Enterprise reporting tool, Clientline and Data File Manager (DFM). | [optional] 
 **ipg_transaction_id** | **String** | The response transaction ID. | [optional] 
 **merchant_transaction_id** | **String** | The unique merchant transaction ID from the request header, if supplied. | [optional] 
+**additional_response_data** | [**AdditionalResponseData**](AdditionalResponseData.md) |  | [optional] 
 
 ## Code Sample
 
@@ -35,7 +36,8 @@ instance = OpenapiClient::PaymentTokenizationResponse.new(client_request_id: 30d
                                  processor: null,
                                  order_id: R-44df6542-ae0b-4415-88e8-7f3e62cc9e5d,
                                  ipg_transaction_id: 838916029301,
-                                 merchant_transaction_id: lsk23532djljff3)
+                                 merchant_transaction_id: lsk23532djljff3,
+                                 additional_response_data: null)
 ```
 
 

data/docs/PaymentUrlDetail.md

@@ -6,7 +6,7 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **payment_url** | **String** | URL for embedded payment link. | [optional] 
 **merchant_transaction_id** | **String** | The unique merchant transaction ID from the request, if supplied. | [optional] 
-**order_id** | **String** | Client order ID if supplied by client, otherwise the order ID. | [optional] 
+**order_id** | **String** | Note - Client Order ID if supplied by client. If not supplied by client, IPG will generate. The first 12 alphanumeric digits are passed down to Fiserv Enterprise reporting tool, Clientline and Data File Manager (DFM). | [optional] 
 **request_time** | **Integer** | The transaction time in seconds since epoch. | [optional] 
 **status** | [**PaymentUrlStatus**](PaymentUrlStatus.md) |  | [optional] 
 

data/docs/PaymentUrlErrorResponse.md

@@ -8,7 +8,7 @@ Name | Type | Description | Notes
 **api_trace_id** | **String** | Request identifier in API, can be used to request logs from the support team. | [optional] 
 **response_type** | [**ResponseType**](ResponseType.md) |  | [optional] 
 **request_status** | **String** | Request status. If it is anything other than 'SUCCESS', please refer to 400s HTTP error codes or decline. See Error object for details. | [optional] 
-**order_id** | **String** | Client order ID if supplied by client, otherwise the order ID. | [optional] 
+**order_id** | **String** | Note - Client Order ID if supplied by client. If not supplied by client, IPG will generate. The first 12 alphanumeric digits are passed down to Fiserv Enterprise reporting tool, Clientline and Data File Manager (DFM). | [optional] 
 **payment_url** | **String** | URL for embedded payment link. | [optional] 
 **transaction_id** | **String** | ID code from the transaction. | [optional] 
 **error** | [**Error**](Error.md) |  | [optional] 

data/docs/PaymentUrlRequest.md

@@ -8,7 +8,7 @@ Name | Type | Description | Notes
 **client_locale** | [**ClientLocale**](ClientLocale.md) |  | [optional] 
 **transaction_amount** | [**Amount**](Amount.md) |  | 
 **transaction_type** | [**TransactionType**](TransactionType.md) |  | 
-**order_id** | **String** | Client order ID if supplied by client, otherwise the order ID. | [optional] 
+**order_id** | **String** | Note - Client Order ID if supplied by client. If not supplied by client, IPG will generate. The first 12 alphanumeric digits are passed down to Fiserv Enterprise reporting tool, Clientline and Data File Manager (DFM). | [optional] 
 **billing** | [**Billing**](Billing.md) |  | [optional] 
 **shipping** | [**Shipping**](Shipping.md) |  | [optional] 
 **transaction_notification_url** | **String** | URL for notifying merchant of payment result. | [optional] 
@@ -19,6 +19,8 @@ Name | Type | Description | Notes
 **purchase_order_number** | **String** | Purchase order number. | [optional] 
 **hosted_payment_page_text** | **String** | The text to be displayed to the payer on the hosted payment page. | [optional] 
 **ip** | **String** | IPv4 or IPv6 network address. | [optional] 
+**revolving_options** | [**RevolvingOptions**](RevolvingOptions.md) |  | [optional] 
+**installment_options** | [**InstallmentOptions**](InstallmentOptions.md) |  | [optional] 
 
 ## Code Sample
 
@@ -39,7 +41,9 @@ instance = OpenapiClient::PaymentUrlRequest.new(store_id: 12345500000,
                                  invoice_number: 96126098,
                                  purchase_order_number: 123055342,
                                  hosted_payment_page_text: This is a payment for x,
-                                 ip: 264.31.73.24)
+                                 ip: 264.31.73.24,
+                                 revolving_options: null,
+                                 installment_options: null)
 ```
 
 

data/docs/PaymentUrlResponse.md

@@ -8,7 +8,7 @@ Name | Type | Description | Notes
 **api_trace_id** | **String** | Request identifier in API, can be used to request logs from the support team. | [optional] 
 **response_type** | [**ResponseType**](ResponseType.md) |  | [optional] 
 **request_status** | **String** | Request status. If it is anything other than 'SUCCESS', please refer to 400s HTTP error codes or decline. See Error object for details. | [optional] 
-**order_id** | **String** | Client order ID if supplied by client, otherwise the order ID. | [optional] 
+**order_id** | **String** | Note - Client Order ID if supplied by client. If not supplied by client, IPG will generate. The first 12 alphanumeric digits are passed down to Fiserv Enterprise reporting tool, Clientline and Data File Manager (DFM). | [optional] 
 **payment_url** | **String** | URL for embedded payment link. | [optional] 
 **transaction_id** | **String** | ID code from the transaction. | [optional] 
 

data/docs/PreAuthSecondaryTransaction.md

@@ -0,0 +1,19 @@
+# OpenapiClient::PreAuthSecondaryTransaction
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**transaction_amount** | [**Amount**](Amount.md) |  | 
+**decremental_flag** | **Boolean** | This flag can only be used in a preAuth transaction that updates the amount of a previous preAuth transaction to either increase the preAuth amount (DecrementalPreAuthFlag = false) or decrease the preAuth amount (DecrementalPreAuthFlag = true). | [optional] [default to false]
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::PreAuthSecondaryTransaction.new(transaction_amount: null,
+                                 decremental_flag: false)
+```
+
+

data/docs/PreAuthSecondaryTransactionAllOf.md

@@ -0,0 +1,19 @@
+# OpenapiClient::PreAuthSecondaryTransactionAllOf
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**transaction_amount** | [**Amount**](Amount.md) |  | 
+**decremental_flag** | **Boolean** | This flag can only be used in a preAuth transaction that updates the amount of a previous preAuth transaction to either increase the preAuth amount (DecrementalPreAuthFlag = false) or decrease the preAuth amount (DecrementalPreAuthFlag = true). | [optional] [default to false]
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::PreAuthSecondaryTransactionAllOf.new(transaction_amount: null,
+                                 decremental_flag: false)
+```
+
+

data/docs/PrimaryTransaction.md

@@ -10,6 +10,8 @@ Name | Type | Description | Notes
 **merchant_transaction_id** | **String** | The unique merchant transaction ID from the request header, if supplied. | [optional] 
 **transaction_origin** | [**TransactionOrigin**](TransactionOrigin.md) |  | [optional] 
 **order** | [**Order**](Order.md) |  | [optional] 
+**ipg_transaction_id** | **Integer** | The IPG transactionId to reference a payerauth for example. | [optional] 
+**allow_partial_approval** | **Boolean** | Indicates if the particular transaction is a partial approval transaction, if supplied. | [optional] 
 
 ## Code Sample
 
@@ -21,7 +23,9 @@ instance = OpenapiClient::PrimaryTransaction.new(request_type: PaymentCardCredit
                                  store_id: 12345500000,
                                  merchant_transaction_id: 30dd879c-ee2f-11db-8314-0800200c9a66,
                                  transaction_origin: null,
-                                 order: null)
+                                 order: null,
+                                 ipg_transaction_id: 8154886515,
+                                 allow_partial_approval: true)
 ```