first_data_gateway 1.6.0 → 1.7.0

data/docs/PaymentTokenVerificationRequestAllOf.md

@@ -0,0 +1,17 @@
+# OpenapiClient::PaymentTokenVerificationRequestAllOf
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**payment_token** | [**UsePaymentToken**](UsePaymentToken.md) |  | 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::PaymentTokenVerificationRequestAllOf.new(payment_token: null)
+```
+
+

data/docs/PaymentTokenizationRequest.md

@@ -9,6 +9,7 @@ Name | Type | Description | Notes
 **billing_address** | [**Address**](Address.md) |  | [optional] 
 **create_token** | [**CreatePaymentToken**](CreatePaymentToken.md) |  | 
 **account_verification** | **Boolean** | If the account should be verified prior to token creation. | [optional] [default to false]
+**additional_details** | [**AdditionalDetails**](AdditionalDetails.md) |  | [optional] 
 
 ## Code Sample
 
@@ -19,7 +20,8 @@ instance = OpenapiClient::PaymentTokenizationRequest.new(request_type: PaymentCa
                                  store_id: 12345500000,
                                  billing_address: null,
                                  create_token: null,
-                                 account_verification: true)
+                                 account_verification: true,
+                                 additional_details: null)
 ```
 
 

data/docs/PaymentTokenizationResponseAllOf.md

@@ -0,0 +1,31 @@
+# OpenapiClient::PaymentTokenizationResponseAllOf
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**request_status** | **String** | The status of the request. | [optional] 
+**request_time** | **Integer** | Time of the request. | [optional] 
+**brand** | **String** | Card brand. | [optional] 
+**country** | **String** | Country of the card issued. | [optional] 
+**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] 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::PaymentTokenizationResponseAllOf.new(request_status: DELETED,
+                                 request_time: 1554308829345,
+                                 brand: VISA,
+                                 country: Germany,
+                                 payment_token: null,
+                                 payment_card: null,
+                                 processor: null,
+                                 order_id: R-44df6542-ae0b-4415-88e8-7f3e62cc9e5d)
+```
+
+

data/docs/PaymentURLApi.md

@@ -94,7 +94,7 @@ 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.
   store_id: 'store_id_example', # String | An optional outlet ID for clients that support multiple stores in the same developer app.
-  transaction_id: 'transaction_id_example', # String | Gateway transaction identifier as returned in the parameter ipgTransactionId.
+  transaction_id: 'transaction_id_example', # String | Gateway transaction identifier as returned in the parameter ipgTransactionId or merchantTransactionId.
   order_id: 'order_id_example', # String | Gateway order identifier as returned in the parameter orderId.
   payment_url_id: 'payment_url_id_example', # String | The ID code from the payment URL.
   transaction_time: 'transaction_time_example' # String | The transaction time in seconds since epoch.
@@ -121,7 +121,7 @@ Name | Type | Description  | Notes
  **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] 
- **transaction_id** | **String**| Gateway transaction identifier as returned in the parameter ipgTransactionId. | [optional] 
+ **transaction_id** | **String**| Gateway transaction identifier as returned in the parameter ipgTransactionId or merchantTransactionId. | [optional] 
  **order_id** | **String**| Gateway order identifier as returned in the parameter orderId. | [optional] 
  **payment_url_id** | **String**| The ID code from the payment URL. | [optional] 
  **transaction_time** | **String**| The transaction time in seconds since epoch. | [optional] 

data/docs/PaymentUrlDetailResponseAllOf.md

@@ -0,0 +1,17 @@
+# OpenapiClient::PaymentUrlDetailResponseAllOf
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**payment_url_details** | [**Array<PaymentUrlDetail>**](PaymentUrlDetail.md) | Array of payment URL details. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::PaymentUrlDetailResponseAllOf.new(payment_url_details: null)
+```
+
+

data/docs/PaymentUrlResponseAllOf.md

@@ -0,0 +1,23 @@
+# OpenapiClient::PaymentUrlResponseAllOf
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**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] 
+**payment_url** | **String** | URL for embedded payment link. | [optional] 
+**transaction_id** | **String** | ID code from the transaction. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::PaymentUrlResponseAllOf.new(request_status: SUCCESS,
+                                 order_id: 123456,
+                                 payment_url: https://api.firstdata.com/connect/gateway/processing?storename=123456789&oid=R-96cdbaa4-c22e-4598-a2f1-c2b5fed79ef1&paymentUrlId=d3eb74fe-cf63-47e1-b89f-52ba0cc7965c,
+                                 transaction_id: 123978432)
+```
+
+

data/docs/RecurringPaymentDetailsResponseAllOf.md

@@ -0,0 +1,17 @@
+# OpenapiClient::RecurringPaymentDetailsResponseAllOf
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**recurring_payment_details** | [**RecurringPaymentDetails**](RecurringPaymentDetails.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::RecurringPaymentDetailsResponseAllOf.new(recurring_payment_details: null)
+```
+
+

data/docs/RemoveFraudBlockedItemsResponseAllOf.md

@@ -0,0 +1,17 @@
+# OpenapiClient::RemoveFraudBlockedItemsResponseAllOf
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**status** | **String** | Status from delete fraud blocked items operation. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::RemoveFraudBlockedItemsResponseAllOf.new(status: SUCCESS. Fraud settings was updated successfully.)
+```
+
+

data/docs/ResponseAmountComponents.md

@@ -19,8 +19,8 @@ require 'OpenapiClient'
 
 instance = OpenapiClient::ResponseAmountComponents.new(subtotal: 8.0,
                                  vat_amount: 0,
-                                 local_tax: 1.3,
-                                 shipping: 1.0,
+                                 local_tax: 1.0,
+                                 shipping: 1.24,
                                  cashback: 2.0,
                                  tip: 6.0,
                                  convenience_fee: 2.0)

data/docs/SecondaryTransaction.md

@@ -6,6 +6,7 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **request_type** | **String** | Object name of the secondary transaction request. | 
 **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] 
 **comments** | **String** | Comment for the secondary transaction. | [optional] 
 **order** | [**Order**](Order.md) |  | [optional] 
 
@@ -16,6 +17,7 @@ require 'OpenapiClient'
 
 instance = OpenapiClient::SecondaryTransaction.new(request_type: PostAuthTransaction,
                                  store_id: 12345500000,
+                                 merchant_transaction_id: lsk23532djljff3,
                                  comments: This is a comment,
                                  order: null)
 ```

data/docs/Secure3D10AuthenticationRequest.md

@@ -4,13 +4,14 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
+**authentication_type** | **String** |  | [optional] 
 
 ## Code Sample
 
 ```ruby
 require 'OpenapiClient'
 
-instance = OpenapiClient::Secure3D10AuthenticationRequest.new()
+instance = OpenapiClient::Secure3D10AuthenticationRequest.new(authentication_type: null)
 ```
 
 

data/docs/Secure3D10AuthenticationRequestAllOf.md

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

data/docs/Secure3D21AuthenticationResult.md

@@ -7,7 +7,7 @@ Name | Type | Description | Notes
 **cavv** | **String** | The Cardholder Authentication Verification Value (CAVV) is a cryptographic value derived by the issuer during payment authentication that can provide evidence of the results of payment authentication during an online purchase. | [optional] 
 **xid** | **String** | The transaction identifier (XID) is a unique tracking number set by the merchant. | [optional] 
 **transaction_id** | **String** | The response transaction UUID. Only applicable to MasterCard. | [optional] 
-**authentication_response** | **String** | The result of authentication attempt returned by the 3D Secure authentication process (PaRes). | [optional] 
+**authentication_response** | **String** | The result of authentication attempt returned by the 3D Secure authentication process (PaRes). | [optional] [default to 'Y']
 **transaction_status** | **String** | The transaction status as returned by the 3D Secure authentication process. | [optional] 
 
 ## Code Sample

data/docs/Secure3D21AuthenticationResultAllOf.md

@@ -7,7 +7,7 @@ Name | Type | Description | Notes
 **cavv** | **String** | The Cardholder Authentication Verification Value (CAVV) is a cryptographic value derived by the issuer during payment authentication that can provide evidence of the results of payment authentication during an online purchase. | [optional] 
 **xid** | **String** | The transaction identifier (XID) is a unique tracking number set by the merchant. | [optional] 
 **transaction_id** | **String** | The response transaction UUID. Only applicable to MasterCard. | [optional] 
-**authentication_response** | **String** | The result of authentication attempt returned by the 3D Secure authentication process (PaRes). | [optional] 
+**authentication_response** | **String** | The result of authentication attempt returned by the 3D Secure authentication process (PaRes). | [optional] [default to 'Y']
 **transaction_status** | **String** | The transaction status as returned by the 3D Secure authentication process. | [optional] 
 
 ## Code Sample

data/docs/Secure3DAuthenticationResponseParams.md

@@ -8,7 +8,7 @@ Name | Type | Description | Notes
 **term_url** | **String** | Terminal URL for processing request. | [optional] 
 **merchant_data** | **String** | Formatted string encoding transaction time, order ID, and return URL data. | [optional] 
 **acs_url** | **String** | The URL for the authentication redirect for the merchant. | [optional] 
-**c_req** | **String** | The CReq message initiates cardholder interaction in a 3DS 2.1 challenge flow and carries authentication data from the cardholder. | [optional] 
+**c_req** | **String** | The CReq message initiates cardholder interaction in a 3DS 2.x challenge flow and carries authentication data from the cardholder. | [optional] 
 **session_data** | **String** | Customer web browser session data. | [optional] 
 
 ## Code Sample

data/docs/SharedSecretConfigurationResponseAllOf.md

@@ -0,0 +1,23 @@
+# OpenapiClient::SharedSecretConfigurationResponseAllOf
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**store_id** | **String** | An optional outlet ID for clients that support multiple stores in the same developer app. | [optional] 
+**shared_secret** | **String** | Shared secret/password for Connect. | [optional] 
+**response_message** | **String** | The message/status received after updating shared secret service config. | [optional] 
+**response_timestamp** | **Integer** | Response timestamp. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::SharedSecretConfigurationResponseAllOf.new(store_id: 12345500000,
+                                 shared_secret: 6768tr457r,
+                                 response_message: SUCCESS,
+                                 response_timestamp: 1561035070)
+```
+
+

data/docs/StoreEmailSettings.md

@@ -0,0 +1,19 @@
+# OpenapiClient::StoreEmailSettings
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | An outlet identificator. | 
+**email_notification_data** | [**EmailNotificationData**](EmailNotificationData.md) |  | 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::StoreEmailSettings.new(id: 12345500000,
+                                 email_notification_data: null)
+```
+
+

data/docs/StoreEmailSettingsResult.md

@@ -0,0 +1,19 @@
+# OpenapiClient::StoreEmailSettingsResult
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | An outlet identificator. | [optional] 
+**status** | **String** | Status from email settings. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::StoreEmailSettingsResult.new(id: 12345500000,
+                                 status: SUCCESS. Email was updated successfully.)
+```
+
+

data/docs/StoreUrlConfigurationResponseAllOf.md

@@ -0,0 +1,17 @@
+# OpenapiClient::StoreUrlConfigurationResponseAllOf
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**stores** | [**Array<StoreUrlConfigurationResult>**](StoreUrlConfigurationResult.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::StoreUrlConfigurationResponseAllOf.new(stores: [{"id":"12099500088","status":"SUCCESS. Connect url settings was changed successfully."},{"id":"12099500044","status":"SUCCESS. Connect url settings was changed successfully."}])
+```
+
+

data/docs/TeleCheckAchPaymentMethod.md

@@ -0,0 +1,53 @@
+# OpenapiClient::TeleCheckAchPaymentMethod
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**ach_type** | **String** | ACH application type values will be one of either TeleCheckICAPaymentMethod or TeleCheckCBPPaymentMethod. | 
+**routing_number** | **String** | Bank routing number. | 
+**account_number** | **String** | Bank account number. | 
+**account_type** | **String** | Identifies if the account type is checking or savings. | 
+**check_number** | **String** | Check number. | [optional] 
+**check_type** | **String** | Identifies if the check type is personal or company. | 
+**product_code** | **String** | Identifies the product code in the transaction. | [optional] 
+**manual_id_info** | [**IdInfo**](IdInfo.md) |  | [optional] 
+**supplement_id_info** | [**IdInfo**](IdInfo.md) |  | [optional] 
+**agent_id** | **String** | Used to track the agent transaction activity. | [optional] 
+**terminal_id** | **String** | Identifies the register or lane number where the original sale transaction occurred. | [optional] 
+**registration_id** | **String** | Unique ID assigned by the merchant for the consumer (never recycled). It is an additional level of authentication. To use this feature, the merchant must work with TeleCheck Risk to discuss. Registration IDs must not be generated for an existing or returning consumer returns. The single registration ID must be unique per consumer. | [optional] 
+**registration_date** | **Date** | Date the consumer originally registered in format MMDDYYYY. | [optional] 
+**release_type** | **String** | Release type is used as a risk variable to gauge risk level when the merchant is releasing the purchased merchandise. | [optional] 
+**vip_customer** | **String** | Flags a transaction as a VIP order (based on merchant criteria). This field should not be sent for non-VIP orders. | [optional] 
+**session_id** | **String** | Session identifier. | 
+**terminal_state** | **String** | Identifies the US state or territory where the original sale transaction occurred. | [optional] 
+**terminal_city** | **String** | Identifies the city where the original sale transaction occurred. | [optional] 
+**ach_bill_to** | [**TeleCheckAchPaymentMethodAchBillTo**](TeleCheckAchPaymentMethodAchBillTo.md) |  | 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::TeleCheckAchPaymentMethod.new(ach_type: TeleCheckICAPaymentMethod,
+                                 routing_number: 1283673312,
+                                 account_number: 2398649823984789,
+                                 account_type: C,
+                                 check_number: 9878867880,
+                                 check_type: P,
+                                 product_code: 128367,
+                                 manual_id_info: null,
+                                 supplement_id_info: null,
+                                 agent_id: RVK001,
+                                 terminal_id: 1283673312,
+                                 registration_id: 12345,
+                                 registration_date: Tue Oct 01 19:00:00 CDT 2019,
+                                 release_type: P,
+                                 vip_customer: Y,
+                                 session_id: fb2e77d.47a0479900504cb3ab4a1f626d174d2d,
+                                 terminal_state: GA,
+                                 terminal_city: Atlanta,
+                                 ach_bill_to: null)
+```
+
+

data/docs/TeleCheckAchPaymentMethodAchBillTo.md

@@ -0,0 +1,35 @@
+# OpenapiClient::TeleCheckAchPaymentMethodAchBillTo
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**first_name** | **String** | Customer billing first name. | [optional] 
+**last_name** | **String** | Customer billing last name. | 
+**address_one** | **String** | Customer billing address, first line. | 
+**address_two** | **String** | Customer billing address, second line. | [optional] 
+**city** | **String** | Customer billing city. | 
+**state** | **String** | Customer billing state. | 
+**zip** | **String** | Customer billing zip code. | 
+**phone** | **String** | Customer billing phone number. | 
+**email** | **String** | Customer billing email. Required if performing an ICA transaction. | [optional] 
+**country_code** | **String** | ISO country code. Required if performing an ICA transaction. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::TeleCheckAchPaymentMethodAchBillTo.new(first_name: R2-D2,
+                                 last_name: O'Calloway,
+                                 address_one: 1234 Line Ave S.,
+                                 address_two: Ste 602,
+                                 city: Atlanta,
+                                 state: GA,
+                                 zip: 30040-1309,
+                                 phone: 9973322990,
+                                 email: abcd.1234@fiserv.com,
+                                 country_code: US)
+```
+
+

data/docs/TeleCheckCBPPaymentMethod.md

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