first_data_gateway 1.4.0 → 1.5.0

data/docs/PaymentUrlDetailResponse.md

@@ -0,0 +1,23 @@
+# OpenapiClient::PaymentUrlDetailResponse
+
+## 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] 
+**payment_url_details** | [**Array<PaymentUrlDetail>**](PaymentUrlDetail.md) | Array of payment URL details. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::PaymentUrlDetailResponse.new(client_request_id: 30dd879c-ee2f-11db-8314-0800200c9a66,
+                                 api_trace_id: rrt-0bd552c12342d3448-b-ea-1142-12938318-7,
+                                 response_type: null,
+                                 payment_url_details: null)
+```
+
+

data/docs/PaymentUrlStatus.md

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

data/docs/{CustomerAddressPhone.md → Phone.md}

@@ -1,4 +1,4 @@
-# OpenapiClient::CustomerAddressPhone
+# OpenapiClient::Phone
 
 ## Properties
 
@@ -12,7 +12,7 @@ Name | Type | Description | Notes
 ```ruby
 require 'OpenapiClient'
 
-instance = OpenapiClient::CustomerAddressPhone.new(type: mobile,
+instance = OpenapiClient::Phone.new(type: mobile,
                                  number: 212-515-1212)
 ```
 

data/docs/ProcessorData.md

@@ -13,6 +13,8 @@ Name | Type | Description | Notes
 **avs_response** | [**AVSResponse**](AVSResponse.md) |  | [optional] 
 **security_code_response** | **String** | Code returned for CVV. | [optional] 
 **merchant_advice_code_indicator** | **String** | Code to map merchant advice code to ISO specification. | [optional] 
+**response_indicator** | **String** | Indicates whether the transaction was routed through the payment card's own network or through a different network. | [optional] 
+**debit_receipt_number** | **String** | Receipt number from debit network provider. | [optional] 
 
 ## Code Sample
 
@@ -27,7 +29,9 @@ instance = OpenapiClient::ProcessorData.new(reference_number: 811720726601,
                                  response_message: Amount specified exceeds allowable limit.,
                                  avs_response: null,
                                  security_code_response: NOT_MATCHED,
-                                 merchant_advice_code_indicator: 01)
+                                 merchant_advice_code_indicator: 01,
+                                 response_indicator: 0100,
+                                 debit_receipt_number: 123456)
 ```
 
 

data/docs/PurchaseCardsLevel3.md

@@ -4,7 +4,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**line_items** | [**Array<PurchaseCardsLevel3LineItems>**](PurchaseCardsLevel3LineItems.md) | Line items. | 
+**line_items** | [**Array<PurchaseCardsLevel3LineItems>**](PurchaseCardsLevel3LineItems.md) | Line items of monitoring and controlling corporate expenditures data. | 
 
 ## Code Sample
 

data/docs/RecurringPaymentDetailsResponse.md

@@ -8,12 +8,10 @@ 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] 
 **order_id** | **String** | Client order ID if supplied by client, otherwise the order ID. | [optional] 
-**transaction_time** | **Integer** | The transaction time in seconds since epoch. | [optional] 
 **billing** | [**Billing**](Billing.md) |  | [optional] 
 **shipping** | [**Shipping**](Shipping.md) |  | [optional] 
-**mandate** | [**SepaMandate**](SepaMandate.md) |  | [optional] 
-**transactions** | [**Array<Transaction>**](Transaction.md) | Required for some payment methods (for example, Klarna). | [optional] 
-**processor** | [**ProcessorData**](ProcessorData.md) |  | [optional] 
+**transactions** | [**Array<TransactionResponse>**](TransactionResponse.md) | Required for some payment methods (for example, Klarna). | [optional] 
+**additional_details** | [**AdditionalDetails**](AdditionalDetails.md) |  | [optional] 
 **recurring_payment_details** | [**RecurringPaymentDetails**](RecurringPaymentDetails.md) |  | [optional] 
 
 ## Code Sample
@@ -25,12 +23,10 @@ instance = OpenapiClient::RecurringPaymentDetailsResponse.new(client_request_id:
                                  api_trace_id: rrt-0bd552c12342d3448-b-ea-1142-12938318-7,
                                  response_type: null,
                                  order_id: 123456,
-                                 transaction_time: 1518811817,
                                  billing: null,
                                  shipping: null,
-                                 mandate: null,
                                  transactions: [{"transactionState":"AUTHORIZED","ipgTransactionId":"838916029301","transactionType":"SALE","transactionAmount":{"total":10.24,"currency":"USD"},"storeId":"1109959991"}],
-                                 processor: null,
+                                 additional_details: null,
                                  recurring_payment_details: null)
 ```
 

data/docs/RegistrationMethod.md

@@ -0,0 +1,29 @@
+# OpenapiClient::RegistrationMethod
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**method_type** | **String** | Unique ID for the payment method type. | 
+**method_id** | **String** | The unique ID of this payment method if it was previously registered with a registration/method or if it is currently being registered. Must be unique for the entire system (not just within a specific merchant or industry). Mandatory if being used inside a registration/method. | [optional] 
+**user_defined** | [**Object**](.md) | A JSON object that carries any additional information that might be helpful for fraud detection. | [optional] 
+**billing_phone_number** | **String** | The address that should be used to send billing information for this payment method. | [optional] 
+**method_alias** | **String** | The address that should be used to send billing information for this payment method. | [optional] 
+**card** | [**FraudRegistrationCard**](FraudRegistrationCard.md) |  | 
+**method_address** | [**FraudAddress**](FraudAddress.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::RegistrationMethod.new(method_type: method/card,
+                                 method_id: 300fa792-bf5f-418e-aa74-d5b3c81298d2,
+                                 user_defined: {"failedPinAttempts":3},
+                                 billing_phone_number: 123456789,
+                                 method_alias: card one,
+                                 card: null,
+                                 method_address: null)
+```
+
+

data/docs/RemoveFraudBlockedItemsResponse.md

@@ -0,0 +1,23 @@
+# OpenapiClient::RemoveFraudBlockedItemsResponse
+
+## 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] 
+**status** | **String** | Status from delete fraud blocked items operation. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::RemoveFraudBlockedItemsResponse.new(client_request_id: 30dd879c-ee2f-11db-8314-0800200c9a66,
+                                 api_trace_id: rrt-0bd552c12342d3448-b-ea-1142-12938318-7,
+                                 response_type: null,
+                                 status: SUCCESS. Fraud settings was updated successfully.)
+```
+
+

data/docs/ScoreOnlyRequest.md

@@ -25,7 +25,7 @@ Name | Type | Description | Notes
 require 'OpenapiClient'
 
 instance = OpenapiClient::ScoreOnlyRequest.new(merchant_ref: ffd031516002,
-                                 transaction_type: scoreOnly,
+                                 transaction_type: score_only,
                                  original_transaction_type: transaction/authorization,
                                  original_transaction_id: fraudFAPI1231231,
                                  amount: 1100,

data/docs/SepaMandate.md

@@ -16,7 +16,7 @@ require 'OpenapiClient'
 
 instance = OpenapiClient::SepaMandate.new(reference: 3RBQVEE,
                                  url: https://www.firstdata.com,
-                                 signature_date: null,
+                                 signature_date: Fri Jul 14 19:00:00 CDT 2017,
                                  type: FINAL_COLLECTION)
 ```
 

data/docs/SharedSecretConfigurationRequest.md

@@ -0,0 +1,17 @@
+# OpenapiClient::SharedSecretConfigurationRequest
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**shared_secret** | **String** | Shared secret/password for Connect. | 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::SharedSecretConfigurationRequest.new(shared_secret: 6768tr457r)
+```
+
+

data/docs/SharedSecretConfigurationResponse.md

@@ -0,0 +1,29 @@
+# OpenapiClient::SharedSecretConfigurationResponse
+
+## 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** | An optional outlet ID for clients that support multiple stores in the same developer app. | [optional] 
+**shared_secret** | **String** | Shared secret/password for Connect. | [optional] 
+**response_message** | **String** | The message/status received after updating shared secret service config. | [optional] 
+**response_timestamp** | **Integer** | Response timestamp. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::SharedSecretConfigurationResponse.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,
+                                 shared_secret: 6768tr457r,
+                                 response_message: SUCCESS,
+                                 response_timestamp: 1561035070)
+```
+
+

data/docs/{FraudOrderShipToAddress.md → ShipToAddress.md}

@@ -1,4 +1,4 @@
-# OpenapiClient::FraudOrderShipToAddress
+# OpenapiClient::ShipToAddress
 
 ## Properties
 
@@ -17,7 +17,7 @@ Name | Type | Description | Notes
 ```ruby
 require 'OpenapiClient'
 
-instance = OpenapiClient::FraudOrderShipToAddress.new(phone: 123-123-1234,
+instance = OpenapiClient::ShipToAddress.new(phone: 123-123-1234,
                                  address1: 123 Second Ave.,
                                  address2: Apt #42,
                                  city: Atlanta,

data/docs/StoreFraudSettings.md

@@ -0,0 +1,19 @@
+# OpenapiClient::StoreFraudSettings
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | The outlet identificator. | 
+**fraud_settings** | [**FraudSettings**](FraudSettings.md) |  | 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::StoreFraudSettings.new(id: 12345500000,
+                                 fraud_settings: null)
+```
+
+

data/docs/StoreFraudSettingsResult.md

@@ -0,0 +1,21 @@
+# OpenapiClient::StoreFraudSettingsResult
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | An outlet identificator. | [optional] 
+**blocked_card_identifier** | [**TokenIdentifier**](TokenIdentifier.md) |  | [optional] 
+**status** | **String** | Status from fraud settings. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::StoreFraudSettingsResult.new(id: 12345500000,
+                                 blocked_card_identifier: null,
+                                 status: SUCCESS)
+```
+
+

data/docs/StoreUrlConfiguration.md

@@ -0,0 +1,31 @@
+# OpenapiClient::StoreUrlConfiguration
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | An optional outlet id for clients that support multiple stores in the same developer app. | 
+**transaction_notification_url** | **String** | Transaction notification URL for Connect. | [optional] 
+**recurring_transaction_notification_url** | **String** | Recurring transaction notification URL for recurring payments. | [optional] 
+**response_success_url** | **String** | Response success URL for Connect. | [optional] 
+**response_failure_url** | **String** | Response failure URL for Connect. | [optional] 
+**skip_result_page_for_success** | **Boolean** | Skip connect result page when transaction is approved. | [optional] 
+**skip_result_page_for_failure** | **Boolean** | Skip connect result page when transaction is not approved. | [optional] 
+**overwrite_url_allowed** | **Boolean** | Overwrite URLs in database by those from request. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::StoreUrlConfiguration.new(id: 12345500000,
+                                 transaction_notification_url: https://ipg-dev-1.1dc.com/webshop/transactionNotification,
+                                 recurring_transaction_notification_url: https://ipg-dev-1.1dc.com/webshop/recurringTransactionNotification,
+                                 response_success_url: https://www.firstdata.com/success,
+                                 response_failure_url: https://www.firstdata.com/failure,
+                                 skip_result_page_for_success: true,
+                                 skip_result_page_for_failure: false,
+                                 overwrite_url_allowed: true)
+```
+
+

data/docs/StoreUrlConfigurationRequest.md

@@ -0,0 +1,17 @@
+# OpenapiClient::StoreUrlConfigurationRequest
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**stores** | [**Array<StoreUrlConfiguration>**](StoreUrlConfiguration.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::StoreUrlConfigurationRequest.new(stores: [{"id":"12099500088","responseFailureUrl":"https://www.firstdata.com/failure","skipResultPageForSuccess":"true","skipResultPageForFailure":"true","overwriteUrlAllowed":"false"},{"id":"12099500044","transactionNotificationUrl":"https://ipg-dev-1.1dc.com/webshop/transactionNotification","recurringTransactionNotificationUrl":"https://ipg-dev-1.1dc.com/webshop/transactionNotification","responseSuccessUrl":"https://www.firstdata.com/success"}])
+```
+
+

data/docs/StoreUrlConfigurationResponse.md

@@ -0,0 +1,23 @@
+# OpenapiClient::StoreUrlConfigurationResponse
+
+## 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] 
+**stores** | [**Array<StoreUrlConfigurationResult>**](StoreUrlConfigurationResult.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::StoreUrlConfigurationResponse.new(client_request_id: 30dd879c-ee2f-11db-8314-0800200c9a66,
+                                 api_trace_id: rrt-0bd552c12342d3448-b-ea-1142-12938318-7,
+                                 response_type: null,
+                                 stores: [{"id":"12099500088","status":"SUCCESS. Connect url settings was changed successfully."},{"id":"12099500044","status":"SUCCESS. Connect url settings was changed successfully."}])
+```
+
+

data/docs/StoreUrlConfigurationResult.md

@@ -0,0 +1,19 @@
+# OpenapiClient::StoreUrlConfigurationResult
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | An optional outlet id for clients that support multiple stores in the same developer app. | [optional] 
+**status** | **String** | Status from store url configuration process. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::StoreUrlConfigurationResult.new(id: 12345500000,
+                                 status: SUCCESS. Connect url settings was changed successfully.)
+```
+
+

data/docs/TokenIdentifier.md

@@ -0,0 +1,17 @@
+# OpenapiClient::TokenIdentifier
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**token_identifier** | **String** | Token identifier. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::TokenIdentifier.new(token_identifier: 00ef9c73d065da1e01b9439998aca5cd6c73ff178660570c8743ed2e4a700f56)
+```
+
+

data/docs/UpdateFraudSettingsRequest.md

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

data/docs/UpdateFraudSettingsResponse.md

@@ -0,0 +1,23 @@
+# OpenapiClient::UpdateFraudSettingsResponse
+
+## 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] 
+**stores** | [**Array<StoreFraudSettingsResult>**](StoreFraudSettingsResult.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::UpdateFraudSettingsResponse.new(client_request_id: 30dd879c-ee2f-11db-8314-0800200c9a66,
+                                 api_trace_id: rrt-0bd552c12342d3448-b-ea-1142-12938318-7,
+                                 response_type: null,
+                                 stores: [{"id":"12345500000","blockedCardIdentifier":{"tokenIdentifier":"570e66b0d4fd91b27155a36911220e0e98d0db7e22fcf0b86544fdf175c707d0"},"status":"SUCCESS. Fraud settings was updated successfully."},{"id":"1234550000044","blockedCardIdentifier":{"tokenIdentifier":"8535993dsrfs9898fssdfgddse9898fv9dfu8f98d0db7e22fcf0b86544fdf178"},"status":"SUCCESS. Fraud settings was updated successfully."}])
+```
+
+