first_data_gateway 1.4.0 → 1.8.0

data/docs/ClearingDetails.md

@@ -0,0 +1,25 @@
+# OpenapiClient::ClearingDetails
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**clearing_elements** | [**Array<ClearingElement>**](ClearingElement.md) | The array contains information about the clearing elements. | [optional] 
+**batch_time_stamp** | **String** | Timestamp when the clearing has been processed. The used format is \"YYYYMMDDhhmmss\". | [optional] 
+**receipt_number_from** | **Integer** | Start receipt number for the clearing process. | [optional] 
+**receipt_number_to** | **Integer** | End receipt number for the clearing process. | [optional] 
+**trace_number** | **Integer** | Trace number for the clearing process. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::ClearingDetails.new(clearing_elements: [{"clearingElement":{"brand":"VISA","value":"1234","count":"1234"}},{"clearingElement":{"brand":"AMEX","value":"4321","count":"999"}}],
+                                 batch_time_stamp: 20190501094321,
+                                 receipt_number_from: 2520,
+                                 receipt_number_to: 2567,
+                                 trace_number: 113744)
+```
+
+

data/docs/ClearingElement.md

@@ -0,0 +1,21 @@
+# OpenapiClient::ClearingElement
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**brand** | **String** | Contains the brand of the card. | [optional] 
+**value** | **Integer** | Holds the total clearing value computed for a specific brand. | [optional] 
+**count** | **Integer** | Specifies the amount of clearing elements for a given brand. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::ClearingElement.new(brand: VISA,
+                                 value: 1234,
+                                 count: 1234)
+```
+
+

data/docs/ClientRegistration.md

@@ -0,0 +1,29 @@
+# OpenapiClient::ClientRegistration
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**merchant_ref** | **String** | Merchant reference code. Used by FirstAPI and reflected in settlement records and webhook notifications. Typically, the merchantRef field is the purchase order number or unique sequence value associated to a given transaction. | [optional] 
+**transaction_type** | **String** | Type of transaction merchant wants to process. | 
+**customer** | [**Customer**](Customer.md) |  | 
+**merchant** | [**Merchant**](Merchant.md) |  | 
+**device** | [**FraudRegistrationDevice**](FraudRegistrationDevice.md) |  | [optional] 
+**user_defined** | [**Object**](.md) | A JSON object that can carry any additional information that might be helpful for fraud detection. | [optional] 
+**original_transaction_type** | **String** | Defines the type of the original transaction that is being evaluated for the Fraud Score. | 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::ClientRegistration.new(merchant_ref: ffd031516002,
+                                 transaction_type: registration,
+                                 customer: null,
+                                 merchant: null,
+                                 device: null,
+                                 user_defined: {"inauthTransId":"1234"},
+                                 original_transaction_type: registration/client)
+```
+
+

data/docs/CombinedMode.md

@@ -0,0 +1,23 @@
+# OpenapiClient::CombinedMode
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**logo** | [**Logo**](Logo.md) |  | [optional] 
+**background** | [**Background**](Background.md) |  | [optional] 
+**text** | [**Text**](Text.md) |  | [optional] 
+**button** | [**Button**](Button.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::CombinedMode.new(logo: null,
+                                 background: null,
+                                 text: null,
+                                 button: null)
+```
+
+

data/docs/ConnectMode.md

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

data/docs/Content.md

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

data/docs/CountryProfile.md

@@ -0,0 +1,17 @@
+# OpenapiClient::CountryProfile
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**profile** | **Integer** | Country profile. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::CountryProfile.new(profile: 99)
+```
+
+

data/docs/CurrencyConversionResponse.md

@@ -0,0 +1,19 @@
+# OpenapiClient::CurrencyConversionResponse
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**dcc_applied** | **Boolean** | Dynamic Currency Conversion Applied. | [optional] 
+**exchange_rate_details** | [**ExchangeRateDetails**](ExchangeRateDetails.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::CurrencyConversionResponse.new(dcc_applied: true,
+                                 exchange_rate_details: null)
+```
+
+

data/docs/CustomerAddress.md

@@ -9,8 +9,8 @@ Name | Type | Description | Notes
 **state_province** | **String** | State or province. | [optional] 
 **city** | **String** | City. | [optional] 
 **country** | **String** | Country. | 
-**phone** | [**CustomerAddressPhone**](CustomerAddressPhone.md) |  | [optional] 
 **zip_postal_code** | **String** | Postal code. | 
+**phone** | [**Phone**](Phone.md) |  | [optional] 
 
 ## Code Sample
 
@@ -22,8 +22,8 @@ instance = OpenapiClient::CustomerAddress.new(street: Apartment 123,
                                  state_province: NY,
                                  city: New York,
                                  country: US,
-                                 phone: null,
-                                 zip_postal_code: 11375)
+                                 zip_postal_code: 11375,
+                                 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/DecryptedApplePay.md

@@ -0,0 +1,27 @@
+# OpenapiClient::DecryptedApplePay
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**account_number** | **String** | Payment card number. | 
+**expiration** | **String** | Card expiration date in MMYYYY format. | 
+**cardholder_name** | **String** | Name of the cardholder. | [optional] 
+**brand** | **String** | Card brand. | [optional] 
+**cryptogram** | **String** | The wallet cryptogram from the decrypted data. | 
+**eci_indicator** | **String** | The ECI indicator from the decrypted data. | 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::DecryptedApplePay.new(account_number: 4111111111111111,
+                                 expiration: 012040,
+                                 cardholder_name: John Doe,
+                                 brand: VISA,
+                                 cryptogram: BB81SRsADvooHCUcDogjMAACAAA=,
+                                 eci_indicator: 05)
+```
+
+

data/docs/DecryptedApplePayWalletPaymentMethod.md

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

data/docs/DecryptedApplePayWalletPaymentMethodAllOf.md

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

data/docs/DecryptedGooglePay.md

@@ -0,0 +1,27 @@
+# OpenapiClient::DecryptedGooglePay
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**account_number** | **String** | Payment card number. | 
+**expiration** | **String** | Card expiration date in MMYYYY format. | 
+**cardholder_name** | **String** | Name of the cardholder. | [optional] 
+**brand** | **String** | Card brand. | [optional] 
+**cryptogram** | **String** | The wallet cryptogram from the decrypted data. | 
+**eci_indicator** | **String** | The ECI indicator from the decrypted data. | 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::DecryptedGooglePay.new(account_number: 4111111111111111,
+                                 expiration: 012040,
+                                 cardholder_name: John Doe,
+                                 brand: VISA,
+                                 cryptogram: BB81SRsADvooHCUcDogjMAACAAA=,
+                                 eci_indicator: 05)
+```
+
+

data/docs/DecryptedGooglePayWalletPaymentMethod.md

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

data/docs/DecryptedGooglePayWalletPaymentMethodAllOf.md

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

data/docs/DecryptedSamsungPay.md

@@ -0,0 +1,27 @@
+# OpenapiClient::DecryptedSamsungPay
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**account_number** | **String** | Payment card number. | 
+**expiration** | **String** | Card expiration date in MMYYYY format. | 
+**cardholder_name** | **String** | Name of the cardholder. | [optional] 
+**brand** | **String** | Card brand. | [optional] 
+**cryptogram** | **String** | The wallet cryptogram from the decrypted data. | 
+**eci_indicator** | **String** | The ECI indicator from the decrypted data. | 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::DecryptedSamsungPay.new(account_number: 4111111111111111,
+                                 expiration: 012040,
+                                 cardholder_name: John Doe,
+                                 brand: VISA,
+                                 cryptogram: BB81SRsADvooHCUcDogjMAACAAA=,
+                                 eci_indicator: 05)
+```
+
+

data/docs/DecryptedSamsungPayWalletPaymentMethod.md

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

data/docs/DecryptedSamsungPayWalletPaymentMethodAllOf.md

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

data/docs/DeleteBrandingStyleConfigurationResponse.md

@@ -0,0 +1,25 @@
+# OpenapiClient::DeleteBrandingStyleConfigurationResponse
+
+## 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] 
+**store_id** | **String** | Store ID number. | [optional] 
+**status** | **String** | Status from delete branding style configuration process. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::DeleteBrandingStyleConfigurationResponse.new(client_request_id: 30dd879c-ee2f-11db-8314-0800200c9a66,
+                                 api_trace_id: rrt-0bd552c12342d3448-b-ea-1142-12938318-7,
+                                 response_type: null,
+                                 store_id: 12345500000,
+                                 status: SUCCESS. Style properties were successfully reset to default.)
+```
+
+

data/docs/Device.md

@@ -6,7 +6,7 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **device_type** | **String** | Defines the type of this object. | 
 **device_id** | **String** | The unique ID of the device. Must be unique for the entire system (not just within a specific merchant or industry). | 
-**networks** | [**Array<DeviceNetworks>**](DeviceNetworks.md) | Information about the networks associated with the device. | [optional] 
+**networks** | [**Array<Items>**](Items.md) | Information about the networks associated with the device. | [optional] 
 **latitude** | **Float** | The GPS decimal latitude, ranging from (-90.0 to 90.0) where positive numbers indicate locations North of the equator. | [optional] 
 **longitude** | **Float** | The GPS decimal longitude, ranging from (-180.0 to 180.0) where positive numbers indicate locations East of the IERS Reference Meridian. | [optional] 
 **imei** | **String** | The device's International Mobile Equipment Identity (IMEI) as described in IETF RFC7254. | [optional]