first_data_gateway 1.5.0 → 1.8.1

data/docs/DecryptedSamsungPay.md

@@ -6,10 +6,8 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **account_number** | **String** | Payment card number. | 
 **expiration** | **String** | Card expiration date in MMYYYY format. | 
-**currency_code** | **String** | Numeric currency code following ISO 4217 standards. | 
-**amount** | **Float** | Amount total. | 
-**cardholder_name** | **String** | Name of the cardholder. | 
-**brand** | **String** | Card brand. | 
+**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. | 
 
@@ -20,8 +18,6 @@ require 'OpenapiClient'
 
 instance = OpenapiClient::DecryptedSamsungPay.new(account_number: 4111111111111111,
                                  expiration: 012040,
-                                 currency_code: 840,
-                                 amount: 10.24,
                                  cardholder_name: John Doe,
                                  brand: VISA,
                                  cryptogram: BB81SRsADvooHCUcDogjMAACAAA=,

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/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)
+```
+
+

data/docs/EndpointResponse.md

@@ -0,0 +1,21 @@
+# OpenapiClient::EndpointResponse
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**endpoint_id** | **String** | Specifies the identifier of an endpoint. | [optional] 
+**status** | **String** | Defines the clearing status of an endpoint. | [optional] 
+**batch_number** | **String** | Defines the batch number of an endpoint clearing process. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::EndpointResponse.new(endpoint_id: CAFEX VISA,
+                                 status: APPROVED,
+                                 batch_number: 000)
+```
+
+

data/docs/ExchangeRateDetails.md

@@ -0,0 +1,33 @@
+# OpenapiClient::ExchangeRateDetails
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**inquiry_rate_id** | **String** | Inquiry rate ID. | [optional] 
+**foreign_currency** | **String** | Foreign currency in alphabetic ISO 4217 currency code format. | [optional] 
+**foreign_amount** | **String** | Foreign amount. | [optional] 
+**exchange_rate** | **String** | Exchange rate. | [optional] 
+**dcc_offered** | **Boolean** | Dcc offered. | [optional] 
+**exchange_rate_source_timestamp** | **String** | Exchange rate source timestamp. The used format is \"yyyy-MM-dd'T'HH:mm:ss.SSSXXX\" | [optional] 
+**expiration_timestamp** | **String** | Expiration timestamp. The used format is \"yyyy-MM-dd'T'HH:mm:ss.SSSXXX\" | [optional] 
+**margin_rate_percentage** | **String** | Margin rate percentage. | [optional] 
+**exchange_rate_source_name** | **String** | Exchange rate source name. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::ExchangeRateDetails.new(inquiry_rate_id: 49150,
+                                 foreign_currency: AUD,
+                                 foreign_amount: 130.33,
+                                 exchange_rate: 1.2968,
+                                 dcc_offered: true,
+                                 exchange_rate_source_timestamp: 2018-12-05T14:13:00.000-05:00,
+                                 expiration_timestamp: 2018-12-05T15:13:00.000-05:00,
+                                 margin_rate_percentage: 3,
+                                 exchange_rate_source_name: REUTERS WHOLESALE INTERBANK)
+```
+
+

data/docs/ExchangeRateResponse.md

@@ -8,16 +8,8 @@ Name | Type | Description | Notes
 **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] 
 **ipg_transaction_id** | **String** | The response transaction ID. | [optional] 
-**request_time** | **String** | Time of the request. | [optional] 
-**inquiry_rate_id** | **String** | Inquiry rate ID. | [optional] 
-**foreign_currency** | **String** | Foreign currency in alphabetic ISO 4217 currency code format. | [optional] 
-**foreign_amount** | **String** | Foreign amount. | [optional] 
-**exchange_rate** | **String** | Exchange rate. | [optional] 
-**dcc_offered** | **String** | Dcc offered. | [optional] 
-**exchange_rate_source_timestamp** | **String** | Exchange rate source timestamp. | [optional] 
-**expiration_timestamp** | **String** | Expiration timestamp. | [optional] 
-**margin_rate_percentage** | **String** | Margin rate percentage. | [optional] 
-**exchange_rate_source_name** | **String** | Exchange rate source name. | [optional] 
+**request_time** | **String** | Time of the request. The used format is \"yyyy-MM-dd'T'HH:mm:ss.SSSXXX\". | [optional] 
+**exchange_rate_details** | [**ExchangeRateDetails**](ExchangeRateDetails.md) |  | [optional] 
 
 ## Code Sample
 
@@ -28,16 +20,8 @@ instance = OpenapiClient::ExchangeRateResponse.new(client_request_id: 30dd879c-e
                                  api_trace_id: rrt-0bd552c12342d3448-b-ea-1142-12938318-7,
                                  response_type: null,
                                  ipg_transaction_id: 838916029301,
-                                 request_time: 2015-06-23T13:46:00.000+02:00,
-                                 inquiry_rate_id: 49150,
-                                 foreign_currency: AUD,
-                                 foreign_amount: 130.33,
-                                 exchange_rate: 1.2968,
-                                 dcc_offered: true,
-                                 exchange_rate_source_timestamp: 2015-06-23T13:46:00.000+02:00,
-                                 expiration_timestamp: 2015-06-23T13:46:00.000+02:00,
-                                 margin_rate_percentage: 3,
-                                 exchange_rate_source_name: REUTERS WHOLESALE INTERBANK)
+                                 request_time: 2018-12-05T14:13:00.000-05:00,
+                                 exchange_rate_details: null)
 ```
 
 

data/docs/Expiration.md

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

data/docs/FontFace.md

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

data/docs/FontProperties.md

@@ -0,0 +1,23 @@
+# OpenapiClient::FontProperties
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**font_face** | [**FontFace**](FontFace.md) |  | [optional] 
+**font_size** | **String** | Font size property. | [optional] 
+**font_weight** | [**FontWeight**](FontWeight.md) |  | [optional] 
+**font_color** | **String** | Hexadecimal color value. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::FontProperties.new(font_face: null,
+                                 font_size: xx-small,
+                                 font_weight: null,
+                                 font_color: #FFEE00)
+```
+
+

data/docs/FontWeight.md

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

data/docs/Footer.md

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

data/docs/FraudOrder.md

@@ -6,6 +6,7 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **ship_to_address** | [**ShipToAddress**](ShipToAddress.md) |  | [optional] 
 **items** | [**Array<FraudOrderItems>**](FraudOrderItems.md) | The list of items included in the order. | [optional] 
+**details_url** | **String** | The URL to the merchant's management system, for reporting and analysis. | [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] 
 
 ## Code Sample
@@ -14,7 +15,8 @@ Name | Type | Description | Notes
 require 'OpenapiClient'
 
 instance = OpenapiClient::FraudOrder.new(ship_to_address: null,
-                                 items: [{"id":"PRODCODE1","name":"The Art of Computer Programming","quantity":"litre","unit":10.23,"unitPrice":{"value":7300,"currency":"USD"},"categories":"[[\"Books\", \"Computers & Technology\", \"Programming\"], [\"Books\", \"Text Books\", \"Computer Science\"]]","detailsUrl":"https://mystore.domain/product/PRODCODE1","userDefined":{"weight":5021.23,"vat":0.06}}],
+                                 items: [{"id":"PRODCODE1","name":"The Art of Computer Programming","quantity":"litre","unit":"1","unitPrice":{"value":7300,"currency":"USD"},"categories":"[[\"Books\", \"Computers & Technology\", \"Programming\"], [\"Books\", \"Text Books\", \"Computer Science\"]]","detailsUrl":"https://mystore.domain/product/PRODCODE1","userDefined":{"weight":5021.23,"vat":0.06}}],
+                                 details_url: https://mystore.domain/product/PRODCODE1,
                                  user_defined: {"delivery":"express","carrier":"ups"})
 ```
 

data/docs/FraudOrderItems.md

@@ -7,9 +7,9 @@ Name | Type | Description | Notes
 **id** | **String** | A unique ID associated with the product. Must be unique within the merchant's system. | [optional] 
 **name** | **String** | A name or short description of the product. | [optional] 
 **quantity** | **String** | The unit in which the product is sold (e.g. litre, kilogram, etc). Leave empty if the product is sold as a complete unit. | [optional] 
-**unit** | **Float** | The number of units sold. Set to 1 if there is only one unit of the item. Leave empty if the quantity is unknown at the time of the request. | [optional] 
+**unit** | **String** | The number of units sold. Set to 1 if there is only one unit of the item. Leave empty if the quantity is unknown at the time of the request. | [optional] 
 **unit_price** | **String** | The price per unit. | [optional] 
-**categories** | **String** | The categories that this product belongs to. | [optional] 
+**categories** | **Array<Array<String>>** | The categories that this product belongs to. | [optional] 
 **details_url** | **String** | The URL to the merchant's management system, for reporting and analysis. | [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] 
 
@@ -21,9 +21,9 @@ require 'OpenapiClient'
 instance = OpenapiClient::FraudOrderItems.new(id: PRODCODE1,
                                  name: The Art of Computer Programming,
                                  quantity: litre,
-                                 unit: 10.23,
+                                 unit: 1,
                                  unit_price: {"value": 7300, "currency": "USD"},
-                                 categories: [["Books", "Computers & Technology", "Programming"], ["Books", "Text Books", "Computer Science"]],
+                                 categories: [["Books, Computers & Technology, Programming"],["Books, Text Books, Computer Science"]],
                                  details_url: https://mystore.domain/product/PRODCODE1,
                                  user_defined: {"weight":5021.23,"vat":0.06})
 ```

data/docs/Header.md

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

data/docs/Hover.md

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

data/docs/IdInfo.md

@@ -0,0 +1,19 @@
+# OpenapiClient::IdInfo
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id_type** | **String** | Identification type. | [optional] 
+**id_data** | **String** | Identification data. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::IdInfo.new(id_type: DL,
+                                 id_data: 12345678)
+```
+
+

data/docs/IndustrySpecificExtensions.md

@@ -7,6 +7,7 @@ Name | Type | Description | Notes
 **airline** | [**Airline**](Airline.md) |  | [optional] 
 **lodging** | [**Lodging**](Lodging.md) |  | [optional] 
 **car_rental** | [**CarRental**](CarRental.md) |  | [optional] 
+**mcc6012** | [**Mcc6012**](Mcc6012.md) |  | [optional] 
 
 ## Code Sample
 
@@ -15,7 +16,8 @@ require 'OpenapiClient'
 
 instance = OpenapiClient::IndustrySpecificExtensions.new(airline: null,
                                  lodging: null,
-                                 car_rental: null)
+                                 car_rental: null,
+                                 mcc6012: null)
 ```
 
 

data/docs/InformationLookupApi.md

@@ -0,0 +1,132 @@
+# OpenapiClient::InformationLookupApi
+
+All URIs are relative to *https://cert.api.firstdata.com/gateway/v2*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**card_info_lookup**](InformationLookupApi.md#card_info_lookup) | **POST** /card-information | Card information lookup.
+[**lookup_account**](InformationLookupApi.md#lookup_account) | **POST** /account-information | Account information lookup.
+
+
+
+## card_info_lookup
+
+> CardInfoLookupResponse card_info_lookup(content_type, client_request_id, api_key, timestamp, card_info_lookup_request, opts)
+
+Card information lookup.
+
+Use this to look up card related information such as issuer country, card function and card brand.
+
+### Example
+
+```ruby
+# load the gem
+require 'openapi_client'
+
+api_instance = OpenapiClient::InformationLookupApi.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).
+card_info_lookup_request = OpenapiClient::CardInfoLookupRequest.new # CardInfoLookupRequest | Accepted request type: CardInfoLookupRequest.
+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
+  #Card information lookup.
+  result = api_instance.card_info_lookup(content_type, client_request_id, api_key, timestamp, card_info_lookup_request, opts)
+  p result
+rescue OpenapiClient::ApiError => e
+  puts "Exception when calling InformationLookupApi->card_info_lookup: #{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). | 
+ **card_info_lookup_request** | [**CardInfoLookupRequest**](CardInfoLookupRequest.md)| Accepted request type: CardInfoLookupRequest. | 
+ **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
+
+[**CardInfoLookupResponse**](CardInfoLookupResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## lookup_account
+
+> CardInfoLookupResponse lookup_account(content_type, client_request_id, api_key, timestamp, account_info_lookup_request, opts)
+
+Account information lookup.
+
+Use this to look up card related information associated with a payment card or payment token.
+
+### Example
+
+```ruby
+# load the gem
+require 'openapi_client'
+
+api_instance = OpenapiClient::InformationLookupApi.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).
+account_info_lookup_request = OpenapiClient::AccountInfoLookupRequest.new # AccountInfoLookupRequest | Accepted request type: PaymentCardInfoLookupRequest and PaymentTokenInfoLookupRequest
+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
+  #Account information lookup.
+  result = api_instance.lookup_account(content_type, client_request_id, api_key, timestamp, account_info_lookup_request, opts)
+  p result
+rescue OpenapiClient::ApiError => e
+  puts "Exception when calling InformationLookupApi->lookup_account: #{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). | 
+ **account_info_lookup_request** | [**AccountInfoLookupRequest**](AccountInfoLookupRequest.md)| Accepted request type: PaymentCardInfoLookupRequest and PaymentTokenInfoLookupRequest | 
+ **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
+
+[**CardInfoLookupResponse**](CardInfoLookupResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+