first_data_gateway 1.6.0 → 1.7.0

data/docs/AccountInfoLookupRequest.md

@@ -0,0 +1,19 @@
+# OpenapiClient::AccountInfoLookupRequest
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**request_type** | **String** | Object name of the account verification request. | 
+**store_id** | **String** | An optional outlet ID for clients that support multiple stores in the same app. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::AccountInfoLookupRequest.new(request_type: PaymentCardInfoLookupRequest,
+                                 store_id: 12345500000)
+```
+
+

data/docs/AccountVerificationRequest.md

@@ -0,0 +1,23 @@
+# OpenapiClient::AccountVerificationRequest
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**request_type** | **String** | Object name of the account verification request. | 
+**billing_address** | [**Address**](Address.md) |  | [optional] 
+**store_id** | **String** | An optional outlet ID for clients that support multiple stores in the same app. | [optional] 
+**additional_details** | [**AdditionalDetails**](AdditionalDetails.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::AccountVerificationRequest.new(request_type: PaymentCardVerificationRequest,
+                                 billing_address: null,
+                                 store_id: 12345500000,
+                                 additional_details: null)
+```
+
+

data/docs/AchCreditTransaction.md

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

data/docs/AchPostAuthTransaction.md

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

data/docs/AchPostAuthTransactionAllOf.md

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

data/docs/AchPreAuthTransaction.md

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

data/docs/AchPreAuthTransactionAllOf.md

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

data/docs/AchRecurringType.md

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

data/docs/AchResponse.md

@@ -0,0 +1,25 @@
+# OpenapiClient::AchResponse
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**response_code** | **String** | Response code for TeleCheck authentication decision in the sale response message. | [optional] 
+**approval_code** | **String** | Code provided if check is approved. | [optional] 
+**reference_number** | **String** | Reference number. | [optional] 
+**preferred_flag** | **String** | Preferred flag. | [optional] 
+**transaction_status** | **String** | Indicates the result of the requested authorization and is returned in the sale response. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::AchResponse.new(response_code: 49,
+                                 approval_code: A123,
+                                 reference_number: 1234567,
+                                 preferred_flag: Y,
+                                 transaction_status: 1)
+```
+
+

data/docs/AchReturnTransaction.md

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

data/docs/AchSaleTransaction.md

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

data/docs/AchVoidTransaction.md

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

data/docs/AdditionalDetails.md

@@ -10,6 +10,7 @@ Name | Type | Description | Notes
 **operator_id** | **String** | The operator ID. | [optional] 
 **sales_system_id** | **String** | The sales system ID. | [optional] 
 **ipg_deferred_auth** | **Boolean** | Indicates if the particular transaction is a deferred authorization. | [optional] 
+**high_risk_purchase_indicator** | **Boolean** | this is highRiskPurchaseIndicator. | [optional] 
 
 ## Code Sample
 
@@ -21,7 +22,8 @@ instance = OpenapiClient::AdditionalDetails.new(comments: This is a comment,
                                  purchase_order_number: 1223456,
                                  operator_id: null,
                                  sales_system_id: null,
-                                 ipg_deferred_auth: true)
+                                 ipg_deferred_auth: true,
+                                 high_risk_purchase_indicator: true)
 ```
 
 

data/docs/Amount.md

@@ -4,7 +4,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**total** | **Float** | Amount total. | 
+**total** | **Float** | Sub component values must add up to total amount. | 
 **currency** | **String** | ISO 4217 currency code. | 
 **components** | [**AmountComponents**](AmountComponents.md) |  | [optional] 
 

data/docs/AmountComponents.md

@@ -18,8 +18,8 @@ require 'OpenapiClient'
 
 instance = OpenapiClient::AmountComponents.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)
 ```

data/docs/BrandingStyleConfigurationResponseAllOf.md

@@ -0,0 +1,17 @@
+# OpenapiClient::BrandingStyleConfigurationResponseAllOf
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**stores** | [**Array<BrandingStyleConfigurationResult>**](BrandingStyleConfigurationResult.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::BrandingStyleConfigurationResponseAllOf.new(stores: null)
+```
+
+

data/docs/CardInfoLookupResponseAllOf.md

@@ -0,0 +1,19 @@
+# OpenapiClient::CardInfoLookupResponseAllOf
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**card_details** | [**Array<CardInfo>**](CardInfo.md) | One or more card information retrieved based on BIN. | [optional] 
+**request_status** | **String** | Request status. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::CardInfoLookupResponseAllOf.new(card_details: [{"brand":"VISA","brandProductId":"VISA BUSINESS","cardFunction":"credit","commercialCard":"CORPORATE","issuerCountry":"DE","issuerName":"First National Bank of Omaha"}],
+                                 request_status: SUCCESS)
+```
+
+

data/docs/ClientRegistrationAllOf.md

@@ -0,0 +1,17 @@
+# OpenapiClient::ClientRegistrationAllOf
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**original_transaction_type** | **String** | Defines the type of the original transaction that is being evaluated for the Fraud Score. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::ClientRegistrationAllOf.new(original_transaction_type: registration/client)
+```
+
+

data/docs/CustomerAddressAllOf.md

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

data/docs/DCCExchangeRateRequest.md

@@ -4,7 +4,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**bin** | **String** | A bank identification number (BIN) of the card to be used for DCC. | 
+**bin** | **String** | The bank identification number (BIN) of the card to be used for DCC. The BIN is the first 6 digits of the card number. | 
 
 ## Code Sample
 

data/docs/DCCExchangeRateRequestAllOf.md

@@ -4,7 +4,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**bin** | **String** | A bank identification number (BIN) of the card to be used for DCC. | 
+**bin** | **String** | The bank identification number (BIN) of the card to be used for DCC. The BIN is the first 6 digits of the card number. | 
 
 ## Code Sample
 

data/docs/DeleteBrandingStyleConfigurationResponseAllOf.md

@@ -0,0 +1,19 @@
+# OpenapiClient::DeleteBrandingStyleConfigurationResponseAllOf
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**store_id** | **String** | Store ID number. | [optional] 
+**status** | **String** | Status from delete branding style configuration process. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::DeleteBrandingStyleConfigurationResponseAllOf.new(store_id: 12345500000,
+                                 status: SUCCESS. Style properties were successfully reset to default.)
+```
+
+

data/docs/DisbursementTransactionType.md

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

data/docs/DisbursementTransactionTypeAllOf.md

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

data/docs/EmailNotificationData.md

@@ -0,0 +1,25 @@
+# OpenapiClient::EmailNotificationData
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**enable_notification** | **Boolean** | Use this to enable/disable email notifications. | [optional] 
+**merchant_name** | **String** | The merchant name to be displayed in the email to customer. | [optional] 
+**receiver_email** | **String** | The email address(es) for receiving transaction notifications. | [optional] 
+**sender_email** | **String** | The email address for sending transaction notifications to customer. | [optional] 
+**locale** | **String** | The locale for received notifications. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::EmailNotificationData.new(enable_notification: true,
+                                 merchant_name: TELECASH 01,
+                                 receiver_email: info@firstdata.com,
+                                 sender_email: do-not-reply@ipg-online.com,
+                                 locale: en_GB)
+```
+
+