first_data_gateway 1.4.0 → 1.5.0

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/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] 

data/docs/EncryptedSamsungPay.md

@@ -0,0 +1,19 @@
+# OpenapiClient::EncryptedSamsungPay
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**data** | **String** | The encrypted wallet payload. | 
+**version** | **String** | Identifies under which encryption/signing scheme this message has been created. In this way, the protocol can evolve over time if needed. For Google Payments transactions, this should be set to ECv1. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::EncryptedSamsungPay.new(data: 8nxjB9mr2tWZeDRQRcGN91UUnb7AioGp3oRo8kmQ6lyvJZiqD7PJlbRCYElNqUmr6Z8zK7b2gO9MKOjpnTCqH0qAe2vuIlwNXB60M2Lh7Qfl3bVgWzwF/FfFcenVW381hoItYi8AjWnWoydz1XMTEv2qhqUG03mEnRXdMyDyk6KKZXoW8Qc0p1F1thbxxu8weU8CZbZsWGGTjB42cilIqLVbribcOAG8Oas1AcgefFsu2hwp4gdSuOg7wmeSV7XKsGQzzVy85qtjuqET2XYzJE3K/Wh9QKkhu5P9Ms5s1+Smr2IjRyidqQa88SxQplrVoo9+PvT0bxFcMspBmO3pLkuaZSUBy++dL2fefcxNJvGCFfFhdxW9DojuuQxgpeu7RAQUsGLyFmr/4ZfBxt882xTmpX9MRx5CAudl9qUgBfKdwWwMX35qSbDTm1ju5XXzNh94VebjD3bB9Zj8qgbmUOr/+6OQLhoFJyBCXgx3EEH8hBwNVFrss/SLwQvFhZh62eO6lOtnmbOtP1yTDDVqGDBfai5SwAmM+KTcc9SGv/xDC+cWe8ck+aCBkG4HoRPapUVMZ3JIgV7yzTsVLJE\\u003d\\,
+                                 version: 100)
+```
+
+

data/docs/EncryptedSamsungPayWalletPaymentMethod.md

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

data/docs/EncryptedSamsungPayWalletPaymentMethodAllOf.md

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

data/docs/ErrorMessage.md

@@ -0,0 +1,19 @@
+# OpenapiClient::ErrorMessage
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**code** | **String** | Error code. | [optional] 
+**description** | **String** | Error description. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::ErrorMessage.new(code: invalid_transaction_type,
+                                 description: The transaction type is not supported)
+```
+
+

data/docs/Expiration.md

@@ -4,8 +4,8 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**month** | **String** | Month of the card expiration date. | 
-**year** | **String** | Year of the card expiration date. | 
+**month** | **String** | Month of the card expiration date in MM format. | 
+**year** | **String** | Year of the card expiration date in YY or YYYY format. | 
 
 ## Code Sample
 

data/docs/FraudAddress.md

@@ -0,0 +1,27 @@
+# OpenapiClient::FraudAddress
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**street** | **String** | First line of street address. | 
+**street2** | **String** | Second line of street address. | [optional] 
+**state_province** | **String** | State or province. | [optional] 
+**city** | **String** | City. | [optional] 
+**country** | **String** | Country. | 
+**zip_postal_code** | **String** | Postal code. | 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::FraudAddress.new(street: Apartment 123,
+                                 street2: 123 Main Street,
+                                 state_province: NY,
+                                 city: New York,
+                                 country: US,
+                                 zip_postal_code: 11375)
+```
+
+

data/docs/FraudDetectApi.md

@@ -4,10 +4,134 @@ All URIs are relative to *https://cert.api.firstdata.com/gateway/v2*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------
+[**fraud_client_registration_post**](FraudDetectApi.md#fraud_client_registration_post) | **POST** /fraud/client-registration | Client registration for fraud detect transaction.
+[**fraud_payment_registration_post**](FraudDetectApi.md#fraud_payment_registration_post) | **POST** /fraud/payment-registration | Payment registration for fraud detect transaction.
 [**score_only**](FraudDetectApi.md#score_only) | **POST** /fraud/score-only | Score a transaction for fraud.
 
 
 
+## fraud_client_registration_post
+
+> FraudRegistrationResponse fraud_client_registration_post(content_type, client_request_id, api_key, timestamp, client_registration, opts)
+
+Client registration for fraud detect transaction.
+
+Use this to register client for fraud detect transaction.
+
+### Example
+
+```ruby
+# load the gem
+require 'openapi_client'
+
+api_instance = OpenapiClient::FraudDetectApi.new
+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).
+client_registration = OpenapiClient::ClientRegistration.new # ClientRegistration | 
+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.
+}
+
+begin
+  #Client registration for fraud detect transaction.
+  result = api_instance.fraud_client_registration_post(content_type, client_request_id, api_key, timestamp, client_registration, opts)
+  p result
+rescue OpenapiClient::ApiError => e
+  puts "Exception when calling FraudDetectApi->fraud_client_registration_post: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **content_type** | **String**| Content type. | [default to 'application/json']
+ **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). | 
+ **client_registration** | [**ClientRegistration**](ClientRegistration.md)|  | 
+ **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] 
+
+### Return type
+
+[**FraudRegistrationResponse**](FraudRegistrationResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## fraud_payment_registration_post
+
+> FraudRegistrationResponse fraud_payment_registration_post(content_type, client_request_id, api_key, timestamp, payment_registration, opts)
+
+Payment registration for fraud detect transaction.
+
+Use this to register payment for fraud detect transaction.
+
+### Example
+
+```ruby
+# load the gem
+require 'openapi_client'
+
+api_instance = OpenapiClient::FraudDetectApi.new
+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).
+payment_registration = OpenapiClient::PaymentRegistration.new # PaymentRegistration | 
+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.
+}
+
+begin
+  #Payment registration for fraud detect transaction.
+  result = api_instance.fraud_payment_registration_post(content_type, client_request_id, api_key, timestamp, payment_registration, opts)
+  p result
+rescue OpenapiClient::ApiError => e
+  puts "Exception when calling FraudDetectApi->fraud_payment_registration_post: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **content_type** | **String**| Content type. | [default to 'application/json']
+ **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). | 
+ **payment_registration** | [**PaymentRegistration**](PaymentRegistration.md)|  | 
+ **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] 
+
+### Return type
+
+[**FraudRegistrationResponse**](FraudRegistrationResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
 ## score_only
 
 > ScoreOnlyResponse score_only(content_type, client_request_id, api_key, timestamp, score_only_request, opts)

data/docs/FraudOrder.md

@@ -4,7 +4,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**ship_to_address** | [**FraudOrderShipToAddress**](FraudOrderShipToAddress.md) |  | [optional] 
+**ship_to_address** | [**ShipToAddress**](ShipToAddress.md) |  | [optional] 
 **items** | [**Array<FraudOrderItems>**](FraudOrderItems.md) | The list of items included in the order. | [optional] 
 **user_defined** | [**Object**](.md) | A JSON object that can carry any additional information about the order that might be helpful for fraud detection. | [optional] 
 

data/docs/FraudRegistration.md

@@ -0,0 +1,27 @@
+# OpenapiClient::FraudRegistration
+
+## 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] 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::FraudRegistration.new(merchant_ref: ffd031516002,
+                                 transaction_type: registration,
+                                 customer: null,
+                                 merchant: null,
+                                 device: null,
+                                 user_defined: {"inauthTransId":"1234"})
+```
+
+

data/docs/FraudRegistrationCard.md

@@ -0,0 +1,27 @@
+# OpenapiClient::FraudRegistrationCard
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**cardholder_name** | **String** | The cardholder name as it appears on the card. | [optional] 
+**card_number** | **String** | Use this field to send clear PAN or tokens other than TransArmor Token. | [optional] 
+**exp_date** | **String** | Payment method expiration date. Format is MMYYYY. | [optional] 
+**cvv_present** | **String** | CVV present indicator. | [optional] 
+**issuer** | **String** | The company (usually a bank) that issued the card. | [optional] 
+**card_reissued_number** | **String** | A number that distinguishes between two plastic cards with the same card number in the event of the card being re-issued. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::FraudRegistrationCard.new(cardholder_name: John F. Doe,
+                                 card_number: 5424180279791732,
+                                 exp_date: 122028,
+                                 cvv_present: Y,
+                                 issuer: Bank of America,
+                                 card_reissued_number: 2)
+```
+
+

data/docs/FraudRegistrationDevice.md

@@ -0,0 +1,39 @@
+# OpenapiClient::FraudRegistrationDevice
+
+## Properties
+
+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<FraudRegistrationDeviceItems>**](FraudRegistrationDeviceItems.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] 
+**model** | **String** | The device's model name. | [optional] 
+**manufacturer** | **String** | The device's manufacturer. | [optional] 
+**timezone_offset** | **String** | The timezone offset from UTC to the devices timezone configuration, specified in the format +hh:mm. | [optional] 
+**rooted** | **Boolean** | A flag indicating that the device has been altered to allow privileged access to users. This flag should only be set to false if a test was performed and the result was negative. Leave unset otherwise. | [optional] 
+**malware_detected** | **Boolean** | A flag indicating that malware was detected on the mobile phone. This flag should only be set to false if a test was performed and the result was negative. Leave unset otherwise. | [optional] 
+**user_defined** | [**Object**](.md) | A JSON object that can carry any additional information about the device that might be helpful for fraud detection. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::FraudRegistrationDevice.new(device_type: device/mobile,
+                                 device_id: BDE000:008945:58AC03:F02569,
+                                 networks: null,
+                                 latitude: 41.14961,
+                                 longitude: -8.61099,
+                                 imei: 49-015420-323751,
+                                 model: iPhone 10,
+                                 manufacturer: Apple,
+                                 timezone_offset: +02:00,
+                                 rooted: false,
+                                 malware_detected: false,
+                                 user_defined: {"battery":"95%"})
+```
+
+

data/docs/FraudRegistrationDeviceItems.md

@@ -0,0 +1,27 @@
+# OpenapiClient::FraudRegistrationDeviceItems
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**network_type** | **String** | Defines the type of network associated with the device. | 
+**ip** | **String** | The IPv4 or IPv6 address of the device if the network assigned one. | [optional] 
+**mac** | **String** | The MAC address of the device that is connected to the Wi-Fi network. | [optional] 
+**ssid** | **String** | The Wi-Fi networks Service Set Identifier (SSID). | [optional] 
+**bssid** | **String** | The Wi-Fi networks Basic Service Set Identifier (BSSID). | [optional] 
+**user_defined** | [**Object**](.md) | A JSON object that can carry any additional information about the network that might be helpful for fraud detection. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::FraudRegistrationDeviceItems.new(network_type: network/wifi,
+                                 ip: 10.201.0.244,
+                                 mac: 02:00:00:00:00:00,
+                                 ssid: Boston-5G-1,
+                                 bssid: e8:fc:af:fb:4b:8c,
+                                 user_defined: {"battery":"5h 10m"})
+```
+
+

data/docs/FraudRegistrationError.md

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