first_data_gateway 1.6.0 → 1.7.0

data/docs/TeleCheckCBPPaymentMethodAllOf.md

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

data/docs/TeleCheckICAPaymentMethod.md

@@ -0,0 +1,21 @@
+# OpenapiClient::TeleCheckICAPaymentMethod
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**customer_ip_address** | **String** | Customer IP address from the terminal where the order was placed (as captured by merchant). | 
+**imei_code** | **String** | International mobile equipment identity code. | [optional] 
+**recurring_type** | [**AchRecurringType**](AchRecurringType.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::TeleCheckICAPaymentMethod.new(customer_ip_address: 11.32.232.44,
+                                 imei_code: 99-000086-247185-4,
+                                 recurring_type: null)
+```
+
+

data/docs/TeleCheckICAPaymentMethodAllOf.md

@@ -0,0 +1,21 @@
+# OpenapiClient::TeleCheckICAPaymentMethodAllOf
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**customer_ip_address** | **String** | Customer IP address from the terminal where the order was placed (as captured by merchant). | 
+**imei_code** | **String** | International mobile equipment identity code. | [optional] 
+**recurring_type** | [**AchRecurringType**](AchRecurringType.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::TeleCheckICAPaymentMethodAllOf.new(customer_ip_address: 11.32.232.44,
+                                 imei_code: 99-000086-247185-4,
+                                 recurring_type: null)
+```
+
+

data/docs/TransactionErrorResponse.md

@@ -15,11 +15,12 @@ Name | Type | Description | Notes
 **payment_method_details** | [**PaymentMethodDetails**](PaymentMethodDetails.md) |  | [optional] 
 **country** | **String** | Country of the card issuer. | [optional] 
 **terminal_id** | **String** | The terminal that is processing the transaction. | [optional] 
+**merchant_id** | **String** | The unique (on Acquirer level) mechant ID. Usually this value has been chosen from the merchant itself and will be used in communication with the endpoint. | [optional] 
 **merchant_transaction_id** | **String** | The unique merchant transaction ID from the request header, if supplied. | [optional] 
 **transaction_time** | **Integer** | The transaction time in seconds since epoch. | [optional] 
 **approved_amount** | [**Amount**](Amount.md) |  | [optional] 
-**transaction_status** | **String** | The status of the transaction. APPROVED/WAITING are returned by the endpoints.  VALIDATION_FAILED/DECLINED are errors. See ErrorResponse object for details. | [optional] 
-**transaction_state** | **String** | The state of the transaction. | [optional] 
+**transaction_status** | **String** | Represents the status of a transaction immediately following the original processing request. This value is not stored for the transaction and is only available in the response when the transaction is processed. TransactionStatus is not returned on either the transaction inquiry or on the order inquiry. | [optional] 
+**transaction_state** | **String** | Shows the state of the current transaction. | [optional] 
 **secure3d_response** | [**Secure3dResponse**](Secure3dResponse.md) |  | [optional] 
 **redirect_url** | **String** | The endpoint redirection URL. | [optional] 
 **authentication_response** | [**Secure3DAuthenticationResponse**](Secure3DAuthenticationResponse.md) |  | [optional] 
@@ -27,6 +28,7 @@ Name | Type | Description | Notes
 **processor** | [**ProcessorData**](ProcessorData.md) |  | [optional] 
 **additional_details** | [**AdditionalTransactionDetails**](AdditionalTransactionDetails.md) |  | [optional] 
 **account_updater_response** | [**AccountUpdaterResponse**](AccountUpdaterResponse.md) |  | [optional] 
+**ach_response** | [**AchResponse**](AchResponse.md) |  | [optional] 
 **error** | [**Error**](Error.md) |  | [optional] 
 
 ## Code Sample
@@ -45,6 +47,7 @@ instance = OpenapiClient::TransactionErrorResponse.new(client_request_id: 30dd87
                                  payment_method_details: null,
                                  country: USA,
                                  terminal_id: 123456,
+                                 merchant_id: 199950008,
                                  merchant_transaction_id: lsk23532djljff3,
                                  transaction_time: 1518811817,
                                  approved_amount: null,
@@ -57,6 +60,7 @@ instance = OpenapiClient::TransactionErrorResponse.new(client_request_id: 30dd87
                                  processor: null,
                                  additional_details: null,
                                  account_updater_response: null,
+                                 ach_response: null,
                                  error: null)
 ```
 

data/docs/TransactionResponse.md

@@ -15,11 +15,12 @@ Name | Type | Description | Notes
 **payment_method_details** | [**PaymentMethodDetails**](PaymentMethodDetails.md) |  | [optional] 
 **country** | **String** | Country of the card issuer. | [optional] 
 **terminal_id** | **String** | The terminal that is processing the transaction. | [optional] 
+**merchant_id** | **String** | The unique (on Acquirer level) mechant ID. Usually this value has been chosen from the merchant itself and will be used in communication with the endpoint. | [optional] 
 **merchant_transaction_id** | **String** | The unique merchant transaction ID from the request header, if supplied. | [optional] 
 **transaction_time** | **Integer** | The transaction time in seconds since epoch. | [optional] 
 **approved_amount** | [**Amount**](Amount.md) |  | [optional] 
-**transaction_status** | **String** | The status of the transaction. APPROVED/WAITING are returned by the endpoints.  VALIDATION_FAILED/DECLINED are errors. See ErrorResponse object for details. | [optional] 
-**transaction_state** | **String** | The state of the transaction. | [optional] 
+**transaction_status** | **String** | Represents the status of a transaction immediately following the original processing request. This value is not stored for the transaction and is only available in the response when the transaction is processed. TransactionStatus is not returned on either the transaction inquiry or on the order inquiry. | [optional] 
+**transaction_state** | **String** | Shows the state of the current transaction. | [optional] 
 **secure3d_response** | [**Secure3dResponse**](Secure3dResponse.md) |  | [optional] 
 **redirect_url** | **String** | The endpoint redirection URL. | [optional] 
 **authentication_response** | [**Secure3DAuthenticationResponse**](Secure3DAuthenticationResponse.md) |  | [optional] 
@@ -27,6 +28,7 @@ Name | Type | Description | Notes
 **processor** | [**ProcessorData**](ProcessorData.md) |  | [optional] 
 **additional_details** | [**AdditionalTransactionDetails**](AdditionalTransactionDetails.md) |  | [optional] 
 **account_updater_response** | [**AccountUpdaterResponse**](AccountUpdaterResponse.md) |  | [optional] 
+**ach_response** | [**AchResponse**](AchResponse.md) |  | [optional] 
 
 ## Code Sample
 
@@ -44,6 +46,7 @@ instance = OpenapiClient::TransactionResponse.new(client_request_id: 30dd879c-ee
                                  payment_method_details: null,
                                  country: USA,
                                  terminal_id: 123456,
+                                 merchant_id: 199950008,
                                  merchant_transaction_id: lsk23532djljff3,
                                  transaction_time: 1518811817,
                                  approved_amount: null,
@@ -55,7 +58,8 @@ instance = OpenapiClient::TransactionResponse.new(client_request_id: 30dd879c-ee
                                  scheme_transaction_id: 019078743804756,
                                  processor: null,
                                  additional_details: null,
-                                 account_updater_response: null)
+                                 account_updater_response: null,
+                                 ach_response: null)
 ```
 
 

data/docs/TransactionResponseAllOf.md

@@ -0,0 +1,59 @@
+# OpenapiClient::TransactionResponseAllOf
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**ipg_transaction_id** | **String** | The response transaction ID. | [optional] 
+**order_id** | **String** | Client order ID if supplied by client, otherwise the order ID. | [optional] 
+**transaction_type** | [**TransactionType**](TransactionType.md) |  | [optional] 
+**payment_token** | [**PaymentTokenDetails**](PaymentTokenDetails.md) |  | [optional] 
+**transaction_origin** | [**TransactionOrigin**](TransactionOrigin.md) |  | [optional] 
+**payment_method_details** | [**PaymentMethodDetails**](PaymentMethodDetails.md) |  | [optional] 
+**country** | **String** | Country of the card issuer. | [optional] 
+**terminal_id** | **String** | The terminal that is processing the transaction. | [optional] 
+**merchant_id** | **String** | The unique (on Acquirer level) mechant ID. Usually this value has been chosen from the merchant itself and will be used in communication with the endpoint. | [optional] 
+**merchant_transaction_id** | **String** | The unique merchant transaction ID from the request header, if supplied. | [optional] 
+**transaction_time** | **Integer** | The transaction time in seconds since epoch. | [optional] 
+**approved_amount** | [**Amount**](Amount.md) |  | [optional] 
+**transaction_status** | **String** | Represents the status of a transaction immediately following the original processing request. This value is not stored for the transaction and is only available in the response when the transaction is processed. TransactionStatus is not returned on either the transaction inquiry or on the order inquiry. | [optional] 
+**transaction_state** | **String** | Shows the state of the current transaction. | [optional] 
+**secure3d_response** | [**Secure3dResponse**](Secure3dResponse.md) |  | [optional] 
+**redirect_url** | **String** | The endpoint redirection URL. | [optional] 
+**authentication_response** | [**Secure3DAuthenticationResponse**](Secure3DAuthenticationResponse.md) |  | [optional] 
+**scheme_transaction_id** | **String** | The transaction ID received from schemes for the initial transaction of card on file flows. | [optional] 
+**processor** | [**ProcessorData**](ProcessorData.md) |  | [optional] 
+**additional_details** | [**AdditionalTransactionDetails**](AdditionalTransactionDetails.md) |  | [optional] 
+**account_updater_response** | [**AccountUpdaterResponse**](AccountUpdaterResponse.md) |  | [optional] 
+**ach_response** | [**AchResponse**](AchResponse.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::TransactionResponseAllOf.new(ipg_transaction_id: 838916029301,
+                                 order_id: 123456,
+                                 transaction_type: null,
+                                 payment_token: null,
+                                 transaction_origin: null,
+                                 payment_method_details: null,
+                                 country: USA,
+                                 terminal_id: 123456,
+                                 merchant_id: 199950008,
+                                 merchant_transaction_id: lsk23532djljff3,
+                                 transaction_time: 1518811817,
+                                 approved_amount: null,
+                                 transaction_status: APPROVED,
+                                 transaction_state: AUTHORIZED,
+                                 secure3d_response: null,
+                                 redirect_url: http://pay.issuer-bank.com/sessionID=123&sharedKey=456,
+                                 authentication_response: null,
+                                 scheme_transaction_id: 019078743804756,
+                                 processor: null,
+                                 additional_details: null,
+                                 account_updater_response: null,
+                                 ach_response: null)
+```
+
+

data/docs/UpdateEmailSettingsRequest.md

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

data/docs/UpdateEmailSettingsResponse.md

@@ -0,0 +1,23 @@
+# OpenapiClient::UpdateEmailSettingsResponse
+
+## 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<StoreEmailSettingsResult>**](StoreEmailSettingsResult.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::UpdateEmailSettingsResponse.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","status":"SUCCESS. Email settings was updated successfully."},{"id":"1234550000044","status":"SUCCESS. Email settings was updated successfully."}])
+```
+
+

data/docs/UpdateEmailSettingsResponseAllOf.md

@@ -0,0 +1,17 @@
+# OpenapiClient::UpdateEmailSettingsResponseAllOf
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**stores** | [**Array<StoreEmailSettingsResult>**](StoreEmailSettingsResult.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::UpdateEmailSettingsResponseAllOf.new(stores: [{"id":"12345500000","status":"SUCCESS. Email settings was updated successfully."},{"id":"1234550000044","status":"SUCCESS. Email settings was updated successfully."}])
+```
+
+

data/docs/UpdateFraudSettingsResponseAllOf.md

@@ -0,0 +1,17 @@
+# OpenapiClient::UpdateFraudSettingsResponseAllOf
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**stores** | [**Array<StoreFraudSettingsResult>**](StoreFraudSettingsResult.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::UpdateFraudSettingsResponseAllOf.new(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."}])
+```
+
+

data/docs/UpdatePaymentToken.md

@@ -0,0 +1,23 @@
+# OpenapiClient::UpdatePaymentToken
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**value** | **String** | Client-supplied payment token value. | 
+**reusable** | **Boolean** | If the token is reusable. | [optional] [default to true]
+**decline_duplicates** | **Boolean** | Decline duplicate payment info if client token is supplied. | [optional] [default to false]
+**payment_card** | [**PaymentCard**](PaymentCard.md) |  | 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::UpdatePaymentToken.new(value: 234ljl124l12,
+                                 reusable: true,
+                                 decline_duplicates: false,
+                                 payment_card: null)
+```
+
+

data/docs/VerificationApi.md

@@ -0,0 +1,132 @@
+# OpenapiClient::VerificationApi
+
+All URIs are relative to *https://cert.api.firstdata.com/gateway/v2*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**verify_account**](VerificationApi.md#verify_account) | **POST** /account-verification | Verify a payment card or payment token.
+[**verify_card**](VerificationApi.md#verify_card) | **POST** /card-verification | Verify a payment card.
+
+
+
+## verify_account
+
+> TransactionResponse verify_account(content_type, client_request_id, api_key, timestamp, account_verification_request, opts)
+
+Verify a payment card or payment token.
+
+Use this to perform an account verification for a payment card or payment token.
+
+### Example
+
+```ruby
+# load the gem
+require 'openapi_client'
+
+api_instance = OpenapiClient::VerificationApi.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_verification_request = OpenapiClient::AccountVerificationRequest.new # AccountVerificationRequest | Accepted request type: PaymentCardVerificationRequest and PaymentTokenVerificationRequest.
+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
+  #Verify a payment card or payment token.
+  result = api_instance.verify_account(content_type, client_request_id, api_key, timestamp, account_verification_request, opts)
+  p result
+rescue OpenapiClient::ApiError => e
+  puts "Exception when calling VerificationApi->verify_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_verification_request** | [**AccountVerificationRequest**](AccountVerificationRequest.md)| Accepted request type: PaymentCardVerificationRequest and PaymentTokenVerificationRequest. | 
+ **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
+
+[**TransactionResponse**](TransactionResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## verify_card
+
+> TransactionResponse verify_card(content_type, client_request_id, api_key, timestamp, card_verification_request, opts)
+
+Verify a payment card.
+
+Use this to perform card verification for a payment card. Use the account-verification endpoint instead for this request.
+
+### Example
+
+```ruby
+# load the gem
+require 'openapi_client'
+
+api_instance = OpenapiClient::VerificationApi.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_verification_request = OpenapiClient::CardVerificationRequest.new # CardVerificationRequest | Accepted request type: CardVerificationRequest.
+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
+  #Verify a payment card.
+  result = api_instance.verify_card(content_type, client_request_id, api_key, timestamp, card_verification_request, opts)
+  p result
+rescue OpenapiClient::ApiError => e
+  puts "Exception when calling VerificationApi->verify_card: #{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_verification_request** | [**CardVerificationRequest**](CardVerificationRequest.md)| Accepted request type: CardVerificationRequest. | 
+ **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
+
+[**TransactionResponse**](TransactionResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/VoidPreAuthTransactions.md

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