first_data_gateway 1.5.0 → 1.8.1

data/docs/Secure3DAuthenticationResponseSecure3dMethod.md

@@ -0,0 +1,35 @@
+# OpenapiClient::Secure3DAuthenticationResponseSecure3dMethod
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**method_form** | **String** | An iframe to be hidden in the browser used to collect browser data for the issuers. This information adds to the overall consumer profile and helps in identifying potentially fraudulent transactions. | [optional] 
+**secure3d_trans_id** | **String** | A unique transaction identifier supplied by the ACS. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::Secure3DAuthenticationResponseSecure3dMethod.new(method_form: <!DOCTYPE iframe SYSTEM "about:legacy-compat"> <iframe id="tdsMmethodTgtFrame" name="tdsMmethodTgtFrame"
+         style="width: 1px; height: 1px; display: none;" src="javascript:false;" xmlns="http://www.w3.org/1999/xhtml">
+<!--.--> </iframe><form id="tdsMmethodForm" name="tdsMmethodForm"
+         action="https://localhost.modirum.com:8543/dstests/ACSEmu2" method="post"
+         target="tdsMmethodTgtFrame" xmlns="http://www.w3.org/1999/xhtml"> <input type="hidden" name="3DSMethodData"
+         value="eyAidGhyZWVEU1NlcnZlclRyYW5zSUQiIDogIjAwMDAwMDAwLTU2NzYtNTY2My04MDAwLTAwMDAw
+
MDAwNDFhOSIsICJ0aHJlZURTTWV0aG9kTm90aWZpY2F0aW9uVVJMIiA6ICJodHRwczovL2xvY
+         2Fs
aG9zdC5tb2RpcnVtLmNvbTo4NTQzL21kcGF5bXBpL01lcmNoYW50U2VydmVyP21uPVkmdHhpZD0x
+
NjgwOSZkaWdlc3Q9aSUyQnhhUEF5NWFOcVJRbllqNmozbWFDZlFJbTdFdjJYTmkwNn
+         h6YmZNJTJG
R3MlM0QiIH0"/> <input type="hidden" name="threeDSMethodData"
+         value="eyAidGhyZWVEU1NlcnZlclRyYW5zSUQiIDogIjAwMDAwMDAwLTU2NzYtNTY2My04MDAwLTAwMDA
+         w
MDAwNDFhOSIsICJ0aHJlZURTTWV0aG9kTm90aWZpY2F0aW9uVVJMIiA6ICJodHRwczovL2xvY
+         2Fs
aG9zdC5tb2RpcnVtLmNvbTo4NTQzL21kcGF5bXBpL01lcmNoYW50U2VydmVyP21uPVkmd
+         HhpZD0x
NjgwOSZkaWdlc3Q9aSUyQnhhUEF5NWFOcVJRbllqNmozbWFDZlFJbTdFdjJYTmkwNn
+         h6YmZNJTJG
R3MlM0QiIH0"/>
+</form><script type="text/javascript" xmlns="http://www.w3.org/1999/xhtml">
+         document.getElementById("tdsMmethodForm").submit(); </script>,
+                                 secure3d_trans_id: 3ac7caa7-aa42-2663-791b-2ac05a542c4a)
+```
+
+

data/docs/SoftDescriptor.md

@@ -5,7 +5,9 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **dynamic_merchant_name** | **String** | Store \"doing-business-as\" name. | 
+**customer_service_number** | **String** | Customer service phone number information that is passed to the issuer (it may appear on the cardholder’s statement) or if merchant wants to pass information that differs from the information stored on our master File. | [optional] 
 **mcc** | **String** | The 4-digit merchant category code (MCC). The merchant might be associated with multiple MCCs. In that case the MCC provided here will be the one that better describes the current transaction. | [optional] 
+**dynamic_address** | [**Address**](Address.md) |  | [optional] 
 
 ## Code Sample
 
@@ -13,7 +15,9 @@ Name | Type | Description | Notes
 require 'OpenapiClient'
 
 instance = OpenapiClient::SoftDescriptor.new(dynamic_merchant_name: Merchant XYZ,
-                                 mcc: 7311)
+                                 customer_service_number: 9973322990,
+                                 mcc: 7311,
+                                 dynamic_address: null)
 ```
 
 

data/docs/StoreBrandingStyleConfiguration.md

@@ -0,0 +1,21 @@
+# OpenapiClient::StoreBrandingStyleConfiguration
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | An optional outlet id for clients that support multiple stores in the same developer app. | 
+**combined** | [**CombinedMode**](CombinedMode.md) |  | [optional] 
+**classic** | [**ClassicMode**](ClassicMode.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::StoreBrandingStyleConfiguration.new(id: 12345500000,
+                                 combined: null,
+                                 classic: null)
+```
+
+

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/StoredCredential.md

@@ -6,7 +6,7 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **sequence** | **String** | Indicates if the transaction is first or subsequent. Valid values are 'FIRST' and 'SUBSEQUENT'. | 
 **scheduled** | **Boolean** | Indicates if the transaction is scheduled or part of an installment. | 
-**referenced_scheme_transaction_id** | **String** | The transaction ID received from schemes for the initial transaction. Required if sequence is 'SUBSEQUENT'. | [optional] 
+**referenced_scheme_transaction_id** | **String** | The transaction ID received from schemes for the initial transaction. May be required if sequence is 'SUBSEQUENT'. | [optional] 
 **initiator** | **String** | Indicates whether it is a merchant-initiated or explicitly consented to by card holder. Valid values are 'MERCHANT' and 'CARDHOLDER'. | [optional] 
 
 ## Code Sample

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,16 @@
+# OpenapiClient::TeleCheckCBPPaymentMethod
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::TeleCheckCBPPaymentMethod.new()
+```
+
+

data/docs/TeleCheckICAPaymentMethod.md

@@ -0,0 +1,21 @@
+# OpenapiClient::TeleCheckICAPaymentMethod
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**customer_ip_address** | **String** | Customer IP address from the terminal where the order was placed (as captured by merchant). | 
+**imei_code** | **String** | International mobile equipment identity code. | [optional] 
+**recurring_type** | [**AchRecurringType**](AchRecurringType.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::TeleCheckICAPaymentMethod.new(customer_ip_address: 11.32.232.44,
+                                 imei_code: 99-000086-247185-4,
+                                 recurring_type: null)
+```
+
+

data/docs/TeleCheckICAPaymentMethodAllOf.md

@@ -0,0 +1,21 @@
+# OpenapiClient::TeleCheckICAPaymentMethodAllOf
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**customer_ip_address** | **String** | Customer IP address from the terminal where the order was placed (as captured by merchant). | 
+**imei_code** | **String** | International mobile equipment identity code. | [optional] 
+**recurring_type** | [**AchRecurringType**](AchRecurringType.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::TeleCheckICAPaymentMethodAllOf.new(customer_ip_address: 11.32.232.44,
+                                 imei_code: 99-000086-247185-4,
+                                 recurring_type: null)
+```
+
+

data/docs/Text.md

@@ -0,0 +1,19 @@
+# OpenapiClient::Text
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**primary** | [**Primary**](Primary.md) |  | [optional] 
+**title** | [**Title**](Title.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::Text.new(primary: null,
+                                 title: null)
+```
+
+

data/docs/Title.md

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

data/docs/TopBar.md

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

data/docs/TransactionErrorResponse.md

@@ -15,18 +15,21 @@ Name | Type | Description | Notes
 **payment_method_details** | [**PaymentMethodDetails**](PaymentMethodDetails.md) |  | [optional] 
 **country** | **String** | Country of the card issuer. | [optional] 
 **terminal_id** | **String** | The terminal that is processing the transaction. | [optional] 
+**merchant_id** | **String** | The unique (on Acquirer level) mechant ID. Usually this value has been chosen from the merchant itself and will be used in communication with the endpoint. | [optional] 
 **merchant_transaction_id** | **String** | The unique merchant transaction ID from the request header, if supplied. | [optional] 
 **transaction_time** | **Integer** | The transaction time in seconds since epoch. | [optional] 
 **approved_amount** | [**Amount**](Amount.md) |  | [optional] 
-**transaction_status** | **String** | The status of the transaction. APPROVED/WAITING are returned by the endpoints.  VALIDATION_FAILED/DECLINED are errors. See ErrorResponse object for details. | [optional] 
-**transaction_state** | **String** | The state of the transaction. | [optional] 
+**transaction_status** | **String** | Represents the status of a transaction immediately following the original processing request. This value is not stored for the transaction and is only available in the response when the transaction is processed. TransactionStatus is not returned on either the transaction inquiry or on the order inquiry. | [optional] 
+**transaction_state** | **String** | Shows the state of the current transaction. | [optional] 
 **secure3d_response** | [**Secure3dResponse**](Secure3dResponse.md) |  | [optional] 
 **redirect_url** | **String** | The endpoint redirection URL. | [optional] 
-**authentication_redirect** | [**AuthenticationRedirect**](AuthenticationRedirect.md) |  | [optional] 
+**authentication_response** | [**Secure3DAuthenticationResponse**](Secure3DAuthenticationResponse.md) |  | [optional] 
 **scheme_transaction_id** | **String** | The transaction ID received from schemes for the initial transaction of card on file flows. | [optional] 
 **processor** | [**ProcessorData**](ProcessorData.md) |  | [optional] 
 **additional_details** | [**AdditionalTransactionDetails**](AdditionalTransactionDetails.md) |  | [optional] 
 **account_updater_response** | [**AccountUpdaterResponse**](AccountUpdaterResponse.md) |  | [optional] 
+**ach_response** | [**AchResponse**](AchResponse.md) |  | [optional] 
+**currency_conversion_response** | [**CurrencyConversionResponse**](CurrencyConversionResponse.md) |  | [optional] 
 **error** | [**Error**](Error.md) |  | [optional] 
 
 ## Code Sample
@@ -45,6 +48,7 @@ instance = OpenapiClient::TransactionErrorResponse.new(client_request_id: 30dd87
                                  payment_method_details: null,
                                  country: USA,
                                  terminal_id: 123456,
+                                 merchant_id: 199950008,
                                  merchant_transaction_id: lsk23532djljff3,
                                  transaction_time: 1518811817,
                                  approved_amount: null,
@@ -52,11 +56,13 @@ instance = OpenapiClient::TransactionErrorResponse.new(client_request_id: 30dd87
                                  transaction_state: AUTHORIZED,
                                  secure3d_response: null,
                                  redirect_url: http://pay.issuer-bank.com/sessionID=123&sharedKey=456,
-                                 authentication_redirect: null,
+                                 authentication_response: null,
                                  scheme_transaction_id: 019078743804756,
                                  processor: null,
                                  additional_details: null,
                                  account_updater_response: null,
+                                 ach_response: null,
+                                 currency_conversion_response: null,
                                  error: null)
 ```
 

data/docs/TransactionResponse.md

@@ -15,18 +15,21 @@ Name | Type | Description | Notes
 **payment_method_details** | [**PaymentMethodDetails**](PaymentMethodDetails.md) |  | [optional] 
 **country** | **String** | Country of the card issuer. | [optional] 
 **terminal_id** | **String** | The terminal that is processing the transaction. | [optional] 
+**merchant_id** | **String** | The unique (on Acquirer level) mechant ID. Usually this value has been chosen from the merchant itself and will be used in communication with the endpoint. | [optional] 
 **merchant_transaction_id** | **String** | The unique merchant transaction ID from the request header, if supplied. | [optional] 
 **transaction_time** | **Integer** | The transaction time in seconds since epoch. | [optional] 
 **approved_amount** | [**Amount**](Amount.md) |  | [optional] 
-**transaction_status** | **String** | The status of the transaction. APPROVED/WAITING are returned by the endpoints.  VALIDATION_FAILED/DECLINED are errors. See ErrorResponse object for details. | [optional] 
-**transaction_state** | **String** | The state of the transaction. | [optional] 
+**transaction_status** | **String** | Represents the status of a transaction immediately following the original processing request. This value is not stored for the transaction and is only available in the response when the transaction is processed. TransactionStatus is not returned on either the transaction inquiry or on the order inquiry. | [optional] 
+**transaction_state** | **String** | Shows the state of the current transaction. | [optional] 
 **secure3d_response** | [**Secure3dResponse**](Secure3dResponse.md) |  | [optional] 
 **redirect_url** | **String** | The endpoint redirection URL. | [optional] 
-**authentication_redirect** | [**AuthenticationRedirect**](AuthenticationRedirect.md) |  | [optional] 
+**authentication_response** | [**Secure3DAuthenticationResponse**](Secure3DAuthenticationResponse.md) |  | [optional] 
 **scheme_transaction_id** | **String** | The transaction ID received from schemes for the initial transaction of card on file flows. | [optional] 
 **processor** | [**ProcessorData**](ProcessorData.md) |  | [optional] 
 **additional_details** | [**AdditionalTransactionDetails**](AdditionalTransactionDetails.md) |  | [optional] 
 **account_updater_response** | [**AccountUpdaterResponse**](AccountUpdaterResponse.md) |  | [optional] 
+**ach_response** | [**AchResponse**](AchResponse.md) |  | [optional] 
+**currency_conversion_response** | [**CurrencyConversionResponse**](CurrencyConversionResponse.md) |  | [optional] 
 
 ## Code Sample
 
@@ -44,6 +47,7 @@ instance = OpenapiClient::TransactionResponse.new(client_request_id: 30dd879c-ee
                                  payment_method_details: null,
                                  country: USA,
                                  terminal_id: 123456,
+                                 merchant_id: 199950008,
                                  merchant_transaction_id: lsk23532djljff3,
                                  transaction_time: 1518811817,
                                  approved_amount: null,
@@ -51,11 +55,13 @@ instance = OpenapiClient::TransactionResponse.new(client_request_id: 30dd879c-ee
                                  transaction_state: AUTHORIZED,
                                  secure3d_response: null,
                                  redirect_url: http://pay.issuer-bank.com/sessionID=123&sharedKey=456,
-                                 authentication_redirect: null,
+                                 authentication_response: null,
                                  scheme_transaction_id: 019078743804756,
                                  processor: null,
                                  additional_details: null,
-                                 account_updater_response: null)
+                                 account_updater_response: null,
+                                 ach_response: null,
+                                 currency_conversion_response: null)
 ```
 
 

data/docs/UnionPayAuthenticationUpdateRequest.md

@@ -0,0 +1,19 @@
+# OpenapiClient::UnionPayAuthenticationUpdateRequest
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**sms_verification_code** | **String** | Customer mobile number for SMS verification. | 
+**security_code** | **String** | Card security code if required by merchant. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::UnionPayAuthenticationUpdateRequest.new(sms_verification_code: 111111,
+                                 security_code: 123)
+```
+
+